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 mint.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
, andupdated
fields. Example: -
Cross-Link Thoughtfully β Prefer absolute links such as
/platform/features/command-center-dashboard
so moves do not break references. -
Update Navigation β Add the new page to
apps/docs/mint.json
in the appropriate group.
β Conventions to Remember
- Navigation mirrors the directory layout; keep related pages together.
- Diagrams use Mermaid 10.8.0 syntax.
- Images belong in
apps/docs/images/
and are referenced with absolute paths (/images/...
). - Docs Linting relies on Biome; run formatting and lint checks before submitting changes.
docs
label so we can continue improving the experience together.