Docs and Categories
Documentation is organized hierarchically with documentations containing categories, which in turn contain individual pages. This structure provides a clean, organized way to present complex documentation to your users.
Documentations
Documentations are the top-level containers that hold your entire knowledge base or user manual. Each documentation represents a complete set of information that can be shared publicly through connected widgets.
Documentation Settings
Each documentation has several configurable settings:
Basic Information:
- Title - The name of your documentation
- Language - The primary language of the content
Branding:
- Light Mode Logo - Logo for light mode display
- Dark Mode Logo - Logo for dark mode display
Widget Connections: Documentations must be connected to widgets to be publicly accessible. Each widget provides a different public URL and visual theme.
Categories
Categories organize documentation pages into logical groups within a documentation. They provide navigation structure and help users find relevant information quickly.
Category Settings
Categories have simple settings:
- Name - The display name of the category
- Description - A brief description for category listings
Category Management
Categories are ordered by weight, which determines their display sequence. Use the up/down arrows to reorder categories as needed.
Publishing & Visibility
Documentation content can be published or unpublished at both the category and page level, giving you fine-grained control over what content is publicly accessible and available in AI knowledge.
Category Publishing
Categories can be published or unpublished from their settings page. When a category is unpublished:
- All pages within the category become unavailable for AI processing
- The category disappears from public documentation navigation
- Child pages remain unpublished even if the category is later republished
Page Publishing
Individual pages can be published or unpublished independently, with these effects:
- Published pages: Available in public documentation and processed for AI knowledge
- Unpublished pages: Hidden from public view and excluded from AI processing
- Parent page dependency: A page cannot be published if its parent page is unpublished
AI Knowledge Integration
Only published pages in published categories are processed for AI knowledge:
- Publishing content automatically adds it to AI knowledge (may take a moment to process)
- Unpublishing content immediately removes it from AI knowledge
- The system prevents publishing pages in unpublished categories
Public Documentation Behavior
Published content follows these rules in public documentation:
- Only published categories appear in the navigation bar
- Only published pages are accessible via public links
- Unpublished content is completely hidden from external users
- Share links for unpublished content will not work
Public Documentation Navigation
When documentation is published publicly, categories appear as a navigation bar below the header when there are multiple categories.
For more details about the public documentation interface, see our public documentation guide.
When a documentation contains only one category, the navigation bar is hidden for a cleaner reading experience.