Document navigation config properties

organize/navigation.mdx

@@ -58,7 +58,7 @@
   alt="Decorative graphic of groups."
 />
 
-In the `navigation` object, `groups` is an array where each entry is an object that requires a `group` field and a `pages` field. The `icon`, `tag`, `root`, and `expanded` fields are optional.
+In the `navigation` object, `groups` is an array where each entry is an object that requires a `group` field and a `pages` field. The `icon`, `tag`, `root`, `expanded`, and `public` fields are optional.
 
 ```json
 {
@@ -120,11 +120,11 @@
 
 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.
 
 <Note>
   The `expanded` property only affects nested groups--groups within groups. Top-level groups are always expanded and cannot be collapsed.
 </Note>
 
 ```json
@@ -141,6 +141,18 @@
 }
 ```
 
+### Public groups
+
+Use the `public` property to make all pages in a group publicly accessible when your site uses [authentication](/deploy/authentication-setup). Pages in a public group are visible to all visitors without requiring login.
+
+```json
+{
+  "group": "Getting started",
+  "public": true,
+  "pages": ["quickstart", "installation"]
+}
+```
+
 ## Tabs
 
 Tabs create distinct sections of your documentation with separate URL paths. Tabs create a horizontal navigation bar at the top of your documentation that lets users switch between sections.
@@ -191,6 +203,30 @@
 }
 ```
 
+### Tab alignment
+
+Use the `align` property to control where a tab appears in the navigation bar. Set `align` to `"end"` to position a tab at the right side of the tab bar. Tabs default to `"start"` alignment.
+
+```json
+{
+  "navigation": {
+    "tabs": [
+      {
+        "tab": "Documentation",
+        "icon": "book-open",
+        "pages": ["quickstart", "guides"]
+      },
+      {
+        "tab": "API status",
+        "icon": "signal",
+        "align": "end",
+        "href": "https://status.example.com"
+      }
+    ]
+  }
+}
+```
+
 ### Menus
 
 Menus add dropdown navigation items to a tab. Use menus to help users go directly to specific pages within a tab.
@@ -332,16 +368,18 @@
 
 Products create a dedicated navigation division for organizing product-specific documentation. Use products to separate different offerings, services, or major feature sets within your documentation.
 
-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.
+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. You can also set a `name` to override the display label shown in the product switcher and a `color` to customize the product icon color.
 
 ```json
 {
   "navigation": {
     "products": [
       {
         "product": "Core API",
+        "name": "API",
         "description": "Core API description",    
         "icon": "api",
+        "color": { "light": "#0369A1", "dark": "#38BDF8" },
         "groups": [
           {
             "group": "Getting started",
@@ -380,9 +418,9 @@
 }
 ```
 
 ## Dropdowns
 
 Dropdowns are an expandable menu at the top of your sidebar navigation. Each item in a dropdown directs to a section of your documentation.
 
 <img
   className="block dark:hidden pointer-events-none"
@@ -396,7 +434,7 @@
   alt="Decorative graphic of a dropdown navigation."
 />
 
-In the `navigation` object, `dropdowns` is an array where each entry is an object that requires a `dropdown` field and can contain other navigation fields such as groups, pages, icons, or links to external pages.
+In the `navigation` object, `dropdowns` is an array where each entry is an object that requires a `dropdown` field and can contain other navigation fields such as groups, pages, icons, or links to external pages. You can also add a `description` and a `color` to customize each dropdown item.
 
 ```json
 {
@@ -405,6 +443,7 @@
       {
         "dropdown": "Documentation",
         "icon": "book-open",
+        "description": "Guides and tutorials for getting started.",
         "pages": [
           "quickstart",
           "development",
@@ -414,6 +453,7 @@
       {
         "dropdown": "API reference",
         "icon": "square-terminal",
+        "color": { "light": "#5B21B6", "dark": "#A78BFA" },
         "pages": [
           "api-reference/get",
           "api-reference/post",
@@ -950,9 +990,9 @@
 
 </CodeGroup>
 
 ## Breadcrumbs
 
 Breadcrumbs display the full navigation path at the top of pages. Some themes have breadcrumbs enabled by default and others do not. You can control whether breadcrumbs display on your site using the `styling` property in your `docs.json`.
 
 <CodeGroup>
 

organize/settings-reference.mdx

@@ -59,6 +59,7 @@
 | `api.examples.defaults` | `"required"` \| `"all"` | No | `"all"` |
 | `api.examples.prefill` | boolean | No | `false` |
 | `api.examples.autogenerate` | boolean | No | `true` |
+| `public` | boolean | No | None |
 | `seo.indexing` | `"navigable"` \| `"all"` | No | `"navigable"` |
 | `seo.metatags` | object | No | None |
 | `search.prompt` | string | No | None |
@@ -145,7 +146,7 @@
 
 Top-level navigation tabs.
 
-**Type:** array of object—each with: `tab` (string, required), `icon` (string), `iconType` (string), `hidden` (boolean), `href` (string uri, required)
+**Type:** array of object—each with: `tab` (string, required), `icon` (string), `iconType` (string), `hidden` (boolean), `align` (`"start"` | `"end"`), `href` (string uri, required)
 
 ##### `navigation.global.anchors`
 
@@ -155,9 +156,9 @@
 
 ##### `navigation.global.dropdowns`
 
 Dropdown menus.
 
-**Type:** array of object—each with: `dropdown` (string, required), `icon` (string), `iconType` (string), `hidden` (boolean), `href` (string uri, required)
+**Type:** array of object—each with: `dropdown` (string, required), `icon` (string), `iconType` (string), `description` (string), `color.light` (string hex), `color.dark` (string hex), `hidden` (boolean), `href` (string uri, required)
 
 ##### `navigation.global.languages`
 
@@ -177,7 +178,7 @@
 
 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), `color.light` (string hex), `color.dark` (string hex)
 
 #### `navigation.languages`
 
@@ -195,7 +196,7 @@
 
 #### `navigation.tabs`
 
-Top-level navigation tabs.
+Top-level navigation tabs. Supports an `align` property (`"start"` | `"end"`) to position tabs within the navigation bar.
 
 **Type:** array of object—see `navigation.global.tabs` for shape.
 
@@ -207,13 +208,13 @@
 
 #### `navigation.dropdowns`
 
-Dropdown menus.
+Dropdown menus. Supports `description` and `color` properties for customization.
 
 **Type:** array of object—see `navigation.global.dropdowns` for shape.
 
 #### `navigation.products`
 
-Product switcher.
+Product switcher. Supports `name` and `color` properties for customization.
 
 **Type:** array of object—see `navigation.global.products` for shape.
 
@@ -231,6 +232,14 @@
 
 ---
 
+### `public`
+
+Whether the documentation is publicly accessible by default. Use with [authentication](/deploy/authentication-setup) to control whether pages require login. When set to `true`, all pages are public unless overridden at the group or page level.
+
+**Type:** boolean
+
+---
+
 ### `description`
 
 Site description for SEO and AI indexing.
@@ -447,14 +456,14 @@
 
 Code block theme configuration.
 
 **Type:** `"system"` | `"dark"` | string (Shiki theme name) | object
 **Default:** `"system"`
 
 When an object:
 
 ##### `styling.codeblocks.theme`
 
 A single Shiki theme name for both modes, or an object with `light` and `dark` Shiki theme names.
 
 **Type:** string or object
 
@@ -466,7 +475,7 @@
 
 ###### `styling.codeblocks.languages.custom`
 
 Paths to JSON files describing custom Shiki languages in [TextMate grammar format](https://macromates.com/manual/en/language_grammars).
 
 **Type:** array of string
 

organize/settings-structure.mdx

@@ -30,6 +30,9 @@ See [Navigation](/organize/navigation) for complete documentation on building yo
           Display name of the tab. Minimum length: 1.
         </ResponseField>
         <IconsOptional />
+        <ResponseField name="align" type='"start" | "end"'>
+          Position the tab at the start or end of the navigation bar. Defaults to `"start"`.
+        </ResponseField>
         <ResponseField name="hidden" type="boolean">
           Whether to hide this tab by default.
         </ResponseField>
@@ -76,6 +79,21 @@ See [Navigation](/organize/navigation) for complete documentation on building yo
           Display name of the dropdown. Minimum length: 1.
         </ResponseField>
         <IconsOptional />
+        <ResponseField name="description" type="string">
+          Description text displayed beneath the dropdown name.
+        </ResponseField>
+        <ResponseField name="color" type="object">
+          Custom colors for the dropdown icon.
+
+          <Expandable title="color">
+            <ResponseField name="light" type="string">
+              Dropdown color for light mode. Must be a hex code beginning with `#`.
+            </ResponseField>
+            <ResponseField name="dark" type="string">
+              Dropdown color for dark mode. Must be a hex code beginning with `#`.
+            </ResponseField>
+          </Expandable>
+        </ResponseField>
         <ResponseField name="hidden" type="boolean">
           Whether to hide this dropdown by default.
         </ResponseField>
@@ -128,12 +146,27 @@ See [Navigation](/organize/navigation) for complete documentation on building yo
 
       <Expandable title="products">
         <ResponseField name="product" type="string" required>
-          Display name of the product.
+          Identifier for the product.
+        </ResponseField>
+        <ResponseField name="name" type="string">
+          Display name shown in the product switcher. Defaults to the `product` value.
         </ResponseField>
         <ResponseField name="description" type="string">
           Description of the product.
         </ResponseField>
         <IconsOptional />
+        <ResponseField name="color" type="object">
+          Custom colors for the product icon.
+
+          <Expandable title="color">
+            <ResponseField name="light" type="string">
+              Product color for light mode. Must be a hex code beginning with `#`.
+            </ResponseField>
+            <ResponseField name="dark" type="string">
+              Product color for dark mode. Must be a hex code beginning with `#`.
+            </ResponseField>
+          </Expandable>
+        </ResponseField>
       </Expandable>
     </ResponseField>
   </Expandable>