Getting Started
The fastest way to understand the DevDocs split between the docs surface and the operator control plane.
The first task is simple: understand where readers go and where operators go. The public docs site should make DevDocs.dev feel like a serious developer product, while the control plane stays focused on management workflows.
Start with the two surfaces
| Surface | Audience | Purpose |
|---|---|---|
devdocs.dev | Developers, reviewers, stakeholders, AI agents | Browse docs, inspect previews, read product guidance, use API references |
admin.devdocs.ai | Operators and customers | Manage sites, previews, domains, and publishing workflow |
Use the docs shell as the public face
The docs app is where we should show clarity, navigation quality, and content depth. It is the best place to demonstrate the pieces that matter to a buyer, reviewer, or developer:
- the section selector at the top of the sidebar
- a meaningful hierarchy of pages and subsections
- readable long-form pages with a sticky right-side TOC
- OpenAPI references that can become safe playgrounds
- SDK-ready examples and side-by-side walkthroughs
No login in the docs UI
DevDocs.dev should stay focused on reading, review, and developer understanding. Authentication belongs in the admin control plane, not in the public docs shell.
Initial operator flow
Open the docs site
Use the public docs app to review navigation, structure, and the current documentation surface.
Move into the control plane only when you need operational work
Operators switch to admin.devdocs.ai for provisioning, preview management, and domain changes.
Review the proof loop before promotion
Promotion should only happen after preview review, proof artifacts, and post-merge verification all line up.
Pick the right section in the docs nav
Use this section for the story readers need first: overview pages, architecture, and authoring guidance.
Use this section for preview-safe deployment rules, promotion proof, and domain orchestration details.
Use this section to verify the docs shell actually shows off cards, tabs, callouts, steps, and polished link treatment.
Read these next
- Platform Architecture for the system split and orchestration model
- Delivery Overview for previews, proof, and promotion
- Content Patterns for richer authoring examples