Knowledge infrastructure
DevDocs.dev
Documentation, API workflows, release proof, and AI-ready references in one calm technical workspace.
import { DevDocs } from "@devdocs/sdk";
const dd = new DevDocs({ key: env.DD_KEY });
const answer = await dd.ask({
question: "How do I rotate an API key?",
sources: ["runbooks", "auth-policies"],
guardrails: "strict",
});
// grounded answer + citationsThree surfaces - one platform
Keep the reader calm. Let the platform do the heavy work.
Documentation
Readable guides, generated references, and source-aware examples stay in one navigable docs tree.
Sources - Sync - SearchAI Automation
Agents, workflows, and SDK examples are grounded in the same docs readers use.
Agents - Runs - ToolsControl Plane
Previews, release proof, permissions, and domain orchestration stay operational without crowding the reader.
Evals - Traces - PolicyProof loop
Ship docs with the same evidence discipline as product code.
Introduction
DevDocs.dev is a developer documentation product for teams that need more than static pages. It pairs readable docs with OpenAPI playgrounds, SDK-ready references, CLI-in-the-web, sandbox-in-the-web, and guided walkthroughs that work for both humans and AI systems.
Guide
Start with the reader-facing structure, onboarding flow, and public docs surface.
Release Workflow
Review previews, run proof loops, and promote changes with confidence.
Component Showcase
Inspect cards, tabs, callouts, steps, accordions, and richer content patterns.
Platform Architecture
See how the public docs surface and authenticated control plane stay separated without feeling disconnected.
Want the bigger picture?
Read Getting Started for the first-run reader journey and Platform Architecture for the system split.
Terminology
Marketing docs surface: The public site at devdocs.dev, designed for readers, reviewers, developers, AI agents, and stakeholders.
Customer docs surface: Hosted documentation for customers lives on devdocs.dev, usually at readable tenant subdomains like <tenant>.devdocs.dev.
Control plane: The authenticated admin experience at admin.devdocs.ai, used for previews, publishing, and domain management.
Proof loop: The verification path that combines local checks, preview review, and post-merge production confirmation.
Review the product shape
Start on the public docs site
The docs shell should feel like a polished developer reference site, not an application dashboard. That means clear hierarchy, a strong table of contents, predictable navigation, and enough depth for API, SDK, and walkthrough content.
Move into operations only when needed
Readers stay on the docs surface. Operators switch into the control plane only for work that actually requires authentication or operational access.
Verify before promotion
Changes should travel through previews, a review battery, and production checks before they are treated as done.
Sidebar sections
Use this section for the pages readers need first: quick start, architecture, and authoring guidance.
Use this section for preview review, release proof, roadmap work, and domain promotion flow.
Use this section to show the docs shell carrying richer UI and content patterns without losing readability.
FAQ
Learn More
Getting Started
The quickest overview of the docs surface and operator flow.
Release Workflow
Preview environments, proof loops, and promotion expectations.
Content Patterns
Richer authoring examples for cards, steps, tabs, and long-form sections.
Navigation Showcase
A focused look at the section selector, left rail, and scroll-following table of contents.