From 1ab7190748e264044bf690ce02b07da47d634adf Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Sat, 21 Mar 2026 01:11:03 +0000 Subject: [PATCH 1/5] Document product name property and site-wide public setting Generated-By: mintlify-agent --- deploy/authentication-setup.mdx | 12 +++++++++++- organize/navigation.mdx | 13 ++++++++++++- organize/settings-reference.mdx | 14 +++++++++++++- 3 files changed, 36 insertions(+), 3 deletions(-) diff --git a/deploy/authentication-setup.mdx b/deploy/authentication-setup.mdx index e909014a9..62873c1b2 100644 --- a/deploy/authentication-setup.mdx +++ b/deploy/authentication-setup.mdx @@ -274,7 +274,17 @@ When an unauthenticated user tries to access a protected page, the redirect to y ## Make pages public -When using authentication, all pages require authentication to access by default. You can make specific pages viewable without authentication at the page or group level with the `public` property. +When using authentication, all pages require authentication to access by default. You can change this default and make specific pages viewable without authentication using the `public` property at the site, group, or page level. + +### Site-wide default + +To make all pages public by default, set `"public": true` at the top level of your `docs.json`. Individual groups or pages can then override this with `"public": false` to require authentication for specific content. + +```json docs.json +{ + "public": true +} +``` ### Individual pages diff --git a/organize/navigation.mdx b/organize/navigation.mdx index 16eaceaed..e6f15e6aa 100644 --- a/organize/navigation.mdx +++ b/organize/navigation.mdx @@ -334,12 +334,23 @@ Products create a dedicated navigation division for organizing product-specific In the `navigation` object, `products` is an array where each entry is an object that requires a `product` field and can contain other navigation fields such as groups, pages, icons, or links to external pages. +Each product supports the following properties: + +| Property | Type | Description | +|---|---|---| +| `product` | string | **Required.** The identifier for the product. | +| `name` | string | Display name shown in the product switcher. Defaults to `product` if not set. | +| `description` | string | Short description of the product. | +| `icon` | string | Icon displayed next to the product name. | +| `hidden` | boolean | When `true`, hides the product from navigation while keeping its pages accessible by URL. | + ```json { "navigation": { "products": [ { - "product": "Core API", + "product": "core-api", + "name": "Core API", "description": "Core API description", "icon": "api", "groups": [ diff --git a/organize/settings-reference.mdx b/organize/settings-reference.mdx index ece433baf..ba976806e 100644 --- a/organize/settings-reference.mdx +++ b/organize/settings-reference.mdx @@ -47,6 +47,7 @@ For context on what each group of settings does, see the topic pages: | `redirects` | array | No | None | | `variables` | object | No | None | | `metadata.timestamp` | boolean | No | `false` | +| `public` | boolean | No | `false` | | `errors.404.redirect` | boolean | No | `true` | | `api.openapi` | string or array or object | No | None | | `api.asyncapi` | string or array or object | No | None | @@ -177,7 +178,7 @@ Version switcher in the global nav. Product switcher in the global nav. -**Type:** array of object—each with: `product` (string, required), `description` (string), `icon` (string), `iconType` (string) +**Type:** array of object—each with: `product` (string, required), `name` (string), `description` (string), `icon` (string), `iconType` (string), `hidden` (boolean) #### `navigation.languages` @@ -671,6 +672,17 @@ Display a last-modified date on all pages. --- +### `public` + +Whether all pages are publicly accessible by default when [authentication](/deploy/authentication-setup) is enabled. + +When `true`, all pages are visible without authentication unless a specific group or page overrides this with `"public": false`. When `false` or omitted, all pages require authentication unless explicitly marked public. + +**Type:** boolean +**Default:** `false` + +--- + ### `errors` Error page settings. From 1c5bfa3b9b2536d61fe0a201dcf39821dd3f5158 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 25 Mar 2026 17:06:26 -0700 Subject: [PATCH 2/5] Update settings-reference.mdx --- organize/settings-reference.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/organize/settings-reference.mdx b/organize/settings-reference.mdx index ba976806e..5e9ed05d8 100644 --- a/organize/settings-reference.mdx +++ b/organize/settings-reference.mdx @@ -178,7 +178,7 @@ Version switcher in the global nav. Product switcher in the global nav. -**Type:** array of object—each with: `product` (string, required), `name` (string), `description` (string), `icon` (string), `iconType` (string), `hidden` (boolean) +**Type:** array of object—each with: `product` (string, required), `name` (string), `description` (string), `icon` (string), `hidden` (boolean) #### `navigation.languages` From 2286f67c502953b9d85c418514f041c3c68c3f5e Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 30 Mar 2026 17:18:42 -0700 Subject: [PATCH 3/5] Correct product name field description name only affects the switcher trigger label (selected product), not the dropdown list items, which always show the product identifier. Co-Authored-By: Claude Sonnet 4.6 --- organize/navigation.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/organize/navigation.mdx b/organize/navigation.mdx index e6f15e6aa..3047bb68c 100644 --- a/organize/navigation.mdx +++ b/organize/navigation.mdx @@ -339,7 +339,7 @@ Each product supports the following properties: | Property | Type | Description | |---|---|---| | `product` | string | **Required.** The identifier for the product. | -| `name` | string | Display name shown in the product switcher. Defaults to `product` if not set. | +| `name` | string | Label shown in the switcher when this product is selected. Defaults to `product` if not set. | | `description` | string | Short description of the product. | | `icon` | string | Icon displayed next to the product name. | | `hidden` | boolean | When `true`, hides the product from navigation while keeping its pages accessible by URL. | From 45a35a22372cbef14ac1475c362bdab6a2f338e8 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 30 Mar 2026 17:22:37 -0700 Subject: [PATCH 4/5] vale --- organize/navigation.mdx | 8 ++++---- organize/settings-reference.mdx | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/organize/navigation.mdx b/organize/navigation.mdx index 3047bb68c..d43e7fd17 100644 --- a/organize/navigation.mdx +++ b/organize/navigation.mdx @@ -120,11 +120,11 @@ Use the `root` property to designate a main page for a group. When a group has a Use the `expanded` property to control the default state of a nested group in the navigation sidebar. -- `expanded: true`: Group is expanded by default. -- `expanded: false` or omitted: Group is collapsed by default. +- `expanded: true`: Group expands by default. +- `expanded: false` or omitted: Group collapses by default. - The `expanded` property only affects nested groups--groups within groups. Top-level groups are always expanded and cannot be collapsed. + The `expanded` property only affects nested groups--groups within groups. Top-level groups always expand and cannot collapse. ```json @@ -339,7 +339,7 @@ Each product supports the following properties: | Property | Type | Description | |---|---|---| | `product` | string | **Required.** The identifier for the product. | -| `name` | string | Label shown in the switcher when this product is selected. Defaults to `product` if not set. | +| `name` | string | Label shown in the switcher when a user selects this product. Defaults to `product` if not set. | | `description` | string | Short description of the product. | | `icon` | string | Icon displayed next to the product name. | | `hidden` | boolean | When `true`, hides the product from navigation while keeping its pages accessible by URL. | diff --git a/organize/settings-reference.mdx b/organize/settings-reference.mdx index 5e9ed05d8..67d5e75b5 100644 --- a/organize/settings-reference.mdx +++ b/organize/settings-reference.mdx @@ -674,7 +674,7 @@ Display a last-modified date on all pages. ### `public` -Whether all pages are publicly accessible by default when [authentication](/deploy/authentication-setup) is enabled. +Whether all pages are publicly accessible by default when a site requires [authentication](/deploy/authentication-setup). When `true`, all pages are visible without authentication unless a specific group or page overrides this with `"public": false`. When `false` or omitted, all pages require authentication unless explicitly marked public. From de7a4bb16b9d6dd0d54e268caae72231541342ae Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 30 Mar 2026 17:26:32 -0700 Subject: [PATCH 5/5] Scope public override docs to page level only MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Group-level public overrides are not reflected in page access control — only frontmatter-level public: false gates unauthenticated access. Co-Authored-By: Claude Sonnet 4.6 --- deploy/authentication-setup.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/deploy/authentication-setup.mdx b/deploy/authentication-setup.mdx index 62873c1b2..b0c407c51 100644 --- a/deploy/authentication-setup.mdx +++ b/deploy/authentication-setup.mdx @@ -274,11 +274,11 @@ When an unauthenticated user tries to access a protected page, the redirect to y ## Make pages public -When using authentication, all pages require authentication to access by default. You can change this default and make specific pages viewable without authentication using the `public` property at the site, group, or page level. +When using authentication, all pages require authentication to access by default. You can change this default and make specific pages viewable without authentication using the `public` property at the site or page level. ### Site-wide default -To make all pages public by default, set `"public": true` at the top level of your `docs.json`. Individual groups or pages can then override this with `"public": false` to require authentication for specific content. +To make all pages public by default, set `"public": true` at the top level of your `docs.json`. Individual pages can then override this with `"public": false` in their frontmatter to require authentication for specific content. ```json docs.json {