Documentation Organization Guide
Welcome to the reorganized Tuturuuu documentation space. This guide explains the new structure so you can find information quickly and add new content with confidence.π§ Top-Level Map
| Section | Purpose | Key Entry Points |
|---|---|---|
| Overview | Vision, mission, and company playbooks | Vision & Mission, Agent Operating Manual |
| Platform | Product experience, AI systems, shared components, personalization | Platform Overview |
| Build | Local setup, monorepo workflows, CI/CD | Build & Ship |
| Learn | Examples, experiments, prompt engineering | Learn & Experiment |
| Reference | Stable APIs and integration contracts | Reference Home |
π Directory Layout
apps/docs/images/. Shared assets for navigation (logo, favicon) sit alongside docs.json, which is the single source of truth for sidebar navigation, theme, and grouping (Mintlify reads it on build). Adding a file to one of the directories above does not publish it until you also register it in docs.json.
βοΈ Adding New Content
- Pick a Section β Choose the directory that matches your topic. When in doubt, align with how end users will search for the information.
-
Create the File β Use front matter with
title,description, andupdatedAtfields. Example:SetupdatedAtto the date you last meaningfully changed the page (YYYY-MM-DD). Keep the single-quote style to match the rest of the docs set. -
Cross-Link Thoughtfully β Prefer absolute links such as
/platform/features/command-center-dashboardso moves do not break references. -
Update Navigation β Add the new page to
apps/docs/docs.jsonin the appropriate group.
β Conventions to Remember
- Navigation is defined in
apps/docs/docs.jsonand should mirror the directory layout; keep related pages together. - Diagrams use Mermaid syntax (rendered by Mintlify).
- Images belong in
apps/docs/images/and are referenced with absolute paths (/images/...). - Internal links use absolute documentation paths (for example
/build/overview, not/overview) so moving files does not break references. - Linting β Markdown and MDX are explicitly excluded from Biome (
biome.jsonignores**/*.mdand**/*.mdx), sobun checkdoes not lint these pages. Validate docs by previewing them with the Mintlify CLI and checking that links resolve and front matter is present, rather than relying on Biome formatting.
docs label so we can continue improving the experience together.