Skip to content

docs: fix overview layout description to clarify TOC behavior #1850

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Nov 7, 2025
Merged

docs: fix overview layout description to clarify TOC behavior #1850

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
418dc60
docs: fix overview layout description to clarify TOC behavior
devin-ai-integration[bot] Nov 7, 2025
88e41f1
nit
devalog Nov 7, 2025
3621bd0
fix wording
devalog Nov 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions fern/products/docs/pages/customization/frontmatter.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,11 +236,11 @@ Currently, relative paths are _not_ supported for this field.
<ParamField path="layout" type="string" required={false} default="guide">
Sets the page layout. Available options:

- `overview`: A spacious, full-width layout without a table of contents. Perfect for landing pages, section overviews, and content that benefits from maximum horizontal space. Navigation sidebar remains visible.

- `guide`: The default documentation layout featuring a table of contents on the right side. Ideal for tutorials, how-to guides, and any content that benefits from easy navigation through sections.

- `reference`: A full-width layout optimized for an API or SDK reference. Removes the table of contents so you can add another column, such as code examples. Navigation sidebar remains visible.
- `overview`: A wider layout (50% wider than `guide`) with a table of contents and navigation sidebar. Perfect for landing pages and section overviews that need more horizontal space while maintaining navigation.

- `reference`: A full-width layout optimized for API or SDK reference. Always hides the table of contents so you can add another column, such as code examples. Navigation sidebar remains visible.

- `page`: A distraction-free, full-screen layout that hides both the table of contents and navigation sidebar. Best for standalone content that benefits from focused reading experiences.

Expand Down