Skip to content

added docs on hidden groups #1043

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 1 commit into from
Aug 20, 2025
Merged

added docs on hidden groups #1043

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
42 changes: 42 additions & 0 deletions guides/hidden-pages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,48 @@
Some navigation elements like sidebars, dropdowns, and tabs may appear empty or shift layout on hidden pages.
</Note>

## Hiding a group of pages

A group of pages is hidden if the `hidden` property is set to `true` in your `docs.json` file:

```json highlight={4}
"groups": [
{
"group": "Getting started",
"hidden": true,
"pages": [
"index",
"quickstart"
]
},
{
"group": "Guides",
"pages": [
"guides/hidden-page.mdx",
"guides/hidden-groups.mdx"
]
}
]
```
In this example, the `Getting started` group is hidden, but the `Guides` group is visible.

### Hiding a tab

You can also hide a tab by adding the `hidden` property to your `docs.json` file:

```json highlight={4}
"tabs": [
{
"tab": "Home",
"hidden": true,
"pages": [
"index",
"quickstart"
]
}
]
```

## Search, SEO, and AI indexing

By default, hidden pages are excluded from indexing for search engines, internal search within your docs, and as context for the AI assistant. To include hidden pages in search results and as context for the assistant, add the `seo` property to your `docs.json`:
Expand All @@ -34,3 +76,3 @@
}
```

Expand Down