docs: avoid hiding content in section index pages, de-dupe project spec overview#345
Open
awphi wants to merge 2 commits into
Open
docs: avoid hiding content in section index pages, de-dupe project spec overview#345awphi wants to merge 2 commits into
awphi wants to merge 2 commits into
Conversation
Signed-off-by: awphi <26072111+awphi@users.noreply.github.com>
Signed-off-by: awphi <26072111+awphi@users.noreply.github.com>
muchzill4
approved these changes
Jul 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Background
One of my pet peeves with docusaurus is its default behaviour to render the content of
index.mdorREADME.mdin subdirectories as a page tied to the section heading of that subdir.For example, currently our
introduction/README.mdcontent is rendered under this clickable 'Overview' section heading:Imo, this harms discoverability of important overview content. Now take a look at (again, imo) a couple of good docs sites with docusaurus-like sidebars:
None of them do this! I prefer the cleanliness of the site feeling like a directory of files and avoiding the directories holding content of their own.
Changes
_category_.jsonfiles to avoid the gripe outlined above.00-overview.mdpage of the project specification. It felt there was not useful content on there not covered in the README and having two overview/introduction type pages was a bit odd. Lmk if you disagree!Old sidebar (section headings are clickable and contain
README.mdcontent):New sidebar (section headings are not clickable!):
Checklist