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

[docs] Headings should be linkable #1181

Open
atomiks opened this issue Dec 19, 2024 · 5 comments
Open

[docs] Headings should be linkable #1181

atomiks opened this issue Dec 19, 2024 · 5 comments
Labels
docs Improvements or additions to the documentation

Comments

@atomiks
Copy link
Contributor

atomiks commented Dec 19, 2024

Docs feedback

It's not possible to click headings to link to subsections of a page. Headings should have <a> tags around them with id hashes.

@atomiks atomiks added the docs Improvements or additions to the documentation label Dec 19, 2024
@colmtuite
Copy link
Contributor

You can click the quick nav link

@atomiks
Copy link
Contributor Author

atomiks commented Dec 19, 2024

You can click the quick nav link

I forgot that was possible, doesn't seem easily discoverable + doesn't work on narrow viewports/mobile?

@imMatheus
Copy link

Still feel like the headers should be linkable IMO, also, would be fairly easy to add no? I could make a quick PR for it

@mnajdova
Copy link
Member

I noticed this and forgot to mention it. The most common use-case for me is to click on the header and share a link with someone. I am already looking at the title, finding it again in the table of content seems like an overkill.

@mj12albert
Copy link
Member

The most common use-case for me is to click on the header and share a link with someone

This is also a big use-case for me, e.g. adding links to GH comments while doing support on-the-go

I think API docs generally have this, examples of some docs I looked at recently:

Radix docs:

radix-select.mp4

Ariakit docs:

The subcomponents in the anatomy are links so that counts? I like that individual props are linkable too

ariakit-select.mp4

RA docs:

The links exist but they are invisible on mobile...

ra-select.mp4

Fastify:

fastify.mp4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants