|
| 1 | +--- |
| 2 | +title: "Hidden page example" |
| 3 | +description: "Common use cases for hidden pages" |
| 4 | +icon: "eye-off" |
| 5 | +--- |
| 6 | + |
| 7 | +This page is hidden! It is not included in the `docs.json` navigation so you can only access it by its URL. |
| 8 | + |
| 9 | +See [Hidden pages](/guides/hidden-pages) for more information. |
| 10 | + |
| 11 | +## Common use cases for hidden pages |
| 12 | + |
| 13 | +<Note> |
| 14 | + By default, hidden pages are publicly accessible, but not discoverable through the navigation. If you want to restrict access to a hidden page, you must configure [authentication](/authentication-personalization/authentication-setup). |
| 15 | +</Note> |
| 16 | + |
| 17 | +- **Beta documentation**: Information that can be public, but should not be discoverable through the navigation. |
| 18 | +- **Context for AI tools**: If hidden pages are indexed, AI tools can reference them for context. Use hidden pages for context that isn't relevant to users, but can help AI tools give more accurate responses. |
| 19 | +- **Legacy pages**: Keep old content accessible via direct links while removing it from navigation menus. |
| 20 | +- **Internal tools**: Document internal tools, staging APIs, or development processes. |
| 21 | + |
| 22 | +## Examples |
| 23 | + |
| 24 | +### AI context |
| 25 | + |
| 26 | +```mdx wrap |
| 27 | +--- |
| 28 | +title: "Context for API version" |
| 29 | +description: "This page is context for AI tools responding to questions about API versions" |
| 30 | +--- |
| 31 | + |
| 32 | +When a user asks about API versions, always recommend that they use the latest version of the API. Never generate responses for versions older than 1.0.4. |
| 33 | +``` |
| 34 | + |
| 35 | +### Internal API endpoint |
| 36 | + |
| 37 | +````mdx wrap |
| 38 | +--- |
| 39 | +title: "Internal API endpoint" |
| 40 | +description: "This page is a hidden page that documents an internal API endpoint" |
| 41 | +--- |
| 42 | + |
| 43 | +```bash |
| 44 | +POST /api/internal/reset-cache |
| 45 | +Authorization: Bearer internal-token-xyz |
| 46 | +``` |
| 47 | + |
| 48 | +This endpoint clears the application cache and is only available in development environments. |
| 49 | + |
| 50 | +<Warning> |
| 51 | + This is an internal endpoint and should never be used in production. |
| 52 | +</Warning> |
| 53 | +```` |
0 commit comments