Skip to main content

Navigation Model

The sidebar in packages/app/src/components/Root/Root.tsx is one of the most important product artifacts in the repo because it tells developers what the platform considers first-class.

Primary navigation groups

ItemMeaning
DashboardExecutive summary of platform health
ClustersCore inventory and entry point for Kubernetes operations
PlatformsCloud-provider filtered entry points
SecuritySecurity and compliance workflows
CostFinOps and optimization lens
MonitoringOperational visibility
DORA MetricsDelivery performance
ToolsUtility and operational support features
DocsKnowledge base and TechDocs bridge
SupportHuman help and operational intake
AI Chat BotAssisted discovery and support

Why this matters for documentation

If the sidebar changes, this docs site should usually change too. The documentation should mirror the product model that developers see when they log in.

Heuristic for future additions

Before adding a new sidebar item, ask:

  1. Is this a new product area or just a subsection of an existing area?
  2. Does it deserve its own top-level documentation section?
  3. Does it introduce a new workflow, new ownership boundary, or new mental model?

If the answer is yes, update both the app and the docs in the same pull request.