docs: fix overview layout description to clarify TOC behavior #1850
+3
−3
Conversation
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
The overview layout documentation incorrectly stated it was 'without a table of contents'. This updates the documentation to accurately reflect that: - Overview layout shows the TOC by default (50% wider than guide layout) - Users can use hide-toc: true to hide it if needed - Reference layout always hides the TOC - This matches the actual implementation and API definition Co-Authored-By: Devin Logan <[email protected]>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
Contributor
jon-fern
approved these changes
Nov 7, 2025
Contributor
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.
Fix overview layout description to clarify TOC behavior
Summary
Corrects the documentation for the
overviewlayout option in the page-level settings (frontmatter). The previous documentation incorrectly stated that overview layout was "without a table of contents", but the actual implementation shows the TOC by default.Changes:
overviewlayout description to clarify it shows TOC by default (50% wider than guide layout)hide-toc: trueto hide the TOC if neededreferencelayout "always hides" the TOC (was "removes")Root cause: The public documentation contradicted both the implementation code (
OverviewLayout.tsxrenders{toc}) and the API definition (frontmatter.ymlstates "the table of contents is still visible").Review & Testing Checklist for Human
layout: overviewand verify the TOC is actually visible (I verified this in code but didn't test live)layout: overviewcombined withhide-toc: truecorrectly hides the TOCNotes