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

hoverxref new name #20

Closed
humitos opened this issue Mar 27, 2023 · 2 comments · Fixed by #379
Closed

hoverxref new name #20

humitos opened this issue Mar 27, 2023 · 2 comments · Fixed by #379

Comments

@humitos
Copy link
Member

humitos commented Mar 27, 2023

I think it could be a good opportunity to re-brand this feature and find a good name for it --not only because the hoverxref name is terrible, but also because it's not tied to "xref" anymore, since that's a Sphinx concept

(from Slack)

We should find some good ideas for this name and more forward with one. I'm using tooltips.js for now.

@agjohnson
Copy link
Contributor

Definitely agree we should update this. Going back to the same conversation around the name of this repo, there is probably some product brainstorming here even.

"Tooltip" to me sounds a bit too low level. The implementation is using a tooltip underneath, but we probably want to communicate that this does something on top of "tooltips".

Also, to my point with the other issue and "client", if we asked a user what "tooltip.js" does, they probably wouldn't guess that it embeds popup documentation.

So for that, I'd get more specific with this feature and the "readthedocs-client" rename. For this feature, perhaps more along the lines of "popup docs", "embedded docs", "hover docs"?

@humitos
Copy link
Member Author

humitos commented Feb 5, 2024

Material for MkDocs calls it "⚡ Instant previews": squidfunk/mkdocs-material#6704

humitos added a commit that referenced this issue Nov 12, 2024
Closes #239 
Closes #20

---------

Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants