| title | Content System | ||||||
|---|---|---|---|---|---|---|---|
| sidebarTitle | Content System | ||||||
| description | This document defines how product messaging, information architecture, and technical depth are organized. | ||||||
| keywords |
|
- provide zero-to-hero comprehension paths
- preserve technical correctness while remaining product-focused
- align content with real user roles and operational goals
Primary docs areas are role- and intent-driven:
- Home / About for orientation and core concepts
- Community for ecosystem participation
- Developers / Gateways / Orchestrators / Delegators for role workflows
- Resources for references, guides, and internal docs tooling
Navigation source files:
docs.jsonv2/pages/**
- value proposition and context framing
- user journey entry points
- concise decision-oriented summaries
- setup, runbooks, migration/checklist pages
- practical workflows with expected outcomes
- APIs, schema/spec docs, command matrices, component details
- troubleshooting and edge-case documentation
- maintain product clarity without sacrificing technical precision
- prefer canonical references over duplicated procedural text
- ensure claims are traceable to code, workflow config, or primary docs
- keep docs maintainable through automation + validation
- Public docs guide pages:
v2/resources/documentation-guide/documentation-guide.mdxv2/resources/documentation-guide/style-guide.mdxv2/resources/documentation-guide/component-library.mdx
- Internal navigation/governance:
docs-guide/README.mdxdocs-guide/source-of-truth-policy.mdx
When adding new content surfaces:
- Place content in the correct IA layer and role context.
- Add or update navigation in
docs.jsonwhere appropriate. - Add automation hooks/index generation only when repeatability is clear.
- Update docs-guide maps so maintainers can discover and govern the feature.