Skip to content

docs: add indexing comparison table to hidden pages #6146

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

Open
Bhavysinghal wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −0
Open

docs: add indexing comparison table to hidden pages #6146

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions organize/hidden-pages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,15 @@ To hide a tab, add the `hidden` property for the tab in your `docs.json` file:

By default, hidden pages don't appear in indexing for search engines, documentation site search, or as AI assistant context. You have two ways to include hidden content in search and indexing.

The following table summarizes how each property affects page visibility and indexing:

| Property | Sidebar Navigation | Site Search | Sitemap | Search Engine Indexing | AI Assistant Context |
|---|---|---|---|---|---|
| `hidden: true` | ❌ Hidden | ❌ Excluded | ❌ Excluded | ❌ Excluded | ❌ Excluded |
| `noindex: true` | ✅ Visible | ✅ Included | ✅ Included | ❌ Excluded | ❌ Excluded |
| `searchable: true` (on hidden tab/group) | ❌ Hidden | ✅ Included | ✅ Included | ✅ Included | ✅ Included |
| `seo.indexing: "all"` (in `docs.json`) | ❌ Hidden | ✅ Included | ✅ Included | ✅ Included | ✅ Included |

### Include all hidden pages

To include every hidden page across your site in search, sitemaps, and AI context, add the `seo` property to your `docs.json`:
Expand Down