Pull documentation content above the fold for documentation pages
Nobody has claimed this yet.
- Dominant language
- Nunjucks
- Stars
- 547
- Forks
- 726
- Avg merge
- 2h 23m
- Merged PRs (30d)
- 3
Description
Most documentation pages have a list of other pages at the top, and then an "On this page" section, and then the content begins. This often pushes the content all the way below the fold. Ideally this does not happen.
As @rdela noted in https://github.com/11ty/eleventy/issues/3388#issuecomment-2256463670
One thing I would like to see that I think would be a big, immediate enhancement to the current docs is to have a more MDN style layout, moving our table of “Contents” outline and jump links from the top of the article to a sidebar on the right, if the screen is wide enough, that follows you down the page and highlights the section of your current scroll position.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file or test is named in the issue. Start by locating the documentation page layout and the code that renders the page list and “On this page” links; compare the current layout with the referenced MDN-style goal. Done means documentation content is visible above the fold where possible, with a responsive sidebar and current-section highlighting on wide screens.
Written by the indexing model from the issue text.
Assessment
- Domain
- design, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100