Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hover-over popups #108

Open
polandll opened this issue Mar 8, 2024 · 2 comments
Open

Hover-over popups #108

polandll opened this issue Mar 8, 2024 · 2 comments
Labels

Comments

@polandll
Copy link

polandll commented Mar 8, 2024

There are any number of reasons that hover-over popups would be a great addition to these docs. Popups for glossary terms, or additional explanation that would be cumbersome in the text. File pathnames, that sort of thing.

Have you considered adding that capability to the publishing?

@eric-schneider
Copy link
Contributor

Examples

MongoDB

MongoDB does this for acronyms: https://www.mongodb.com/docs/atlas/security-vpc-peering/

image

Stripe

Stripe does this for xrefs (internal docs links): https://docs.stripe.com/stripe-data/access-data-in-warehouse#financial-reports-in-data-pipeline

image

Wikipedia

Wikipedia goes a little further than Stripe: https://en.wikipedia.org/wiki/Main_Page

image

@KimberlyFields
Copy link

KimberlyFields commented Aug 14, 2024

An additional use case is in code blocks to provide explanations of placeholders or parameters. See https://datastax.slack.com/archives/G019S5D8AM7/p1723656751643779 for context.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants