Deep Linking in Docs
Open
v2
- Dominant language
- JavaScript
- Stars
- 83
- Forks
- 36
- PR merge metrics
- No merged PRs in 30d
Description
Currently in the documentation, you can click a top-level item, or one of its children, if you click a child, it takes you to a dedicated page for that child. It would probably be better if it took you to the top-level page but scrolled you to that item, and added a `#` to the URL, rather than a unique URL.
Contributor guide
Research direction
The issue names only the documentation navigation between top-level items and child items; no files, tests, or entry points are provided. Start by locating the code that generates those links and pages, then verify that a child link opens its top-level page, scrolls to the matching item, and includes a hash in the URL.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100