Official documentation for DojOps, the AI DevOps Automation Engine.
Live: docs.dojops.ai
- Next.js 15.1 (App Router, standalone output)
- Nextra 4.2 + nextra-theme-docs (MDX documentation framework)
- React 19 + TypeScript 5.7
18 MDX pages organized into 6 sections:
content/
├── index.mdx # Introduction
├── getting-started/
│ ├── installation.mdx # Prerequisites, npm/curl/Docker install
│ ├── quickstart.mdx # First run, basic workflow
│ ├── configuration.mdx # Providers, env vars, profiles
│ └── providers.mdx # Add, remove, switch LLM providers
├── usage/
│ ├── cli.mdx # CLI command reference
│ ├── api.mdx # 19 REST endpoints with examples
│ └── dashboard.mdx # Web dashboard overview
├── architecture/
│ ├── overview.mdx # System design, package layers, data flow
│ └── security-model.mdx # Defense-in-depth, trust boundaries
├── components/
│ ├── agents.mdx # 17 built-in agents + custom agents
│ ├── tools.mdx # 18 DevOps skills + custom skill system
│ ├── tool-spec-v1.mdx # Frozen v1 tool contract
│ ├── security-scanning.mdx # 10 scanners, modes, remediation
│ ├── execution-engine.mdx # SafeExecutor, policies, audit logging
│ └── planner.mdx # Task decomposition, topological execution
└── community/
├── contributing.mdx # Dev setup, commit conventions, PR checklist
└── troubleshooting.mdx # FAQ, common issues, debugging
Navigation is controlled by _meta.js files in each directory.
Configured in app/layout.tsx:
- Navbar: DojOps logo + GitHub project link
- Banner: Promotional link to dojops.ai (dismissible)
- Sidebar: Collapsible, first level expanded by default
- Footer: MIT license + copyright
- Edit link: "Edit this page on GitHub" pointing to this repo
- Metadata: Title template
%s, DojOps Docs, favicon
- Node.js >= 20
git clone https://github.com/dojops/dojops-doc.git
cd dojops-doc
npm install
npm run devnpm run dev # Dev server with hot reload (http://localhost:3000)
npm run build # Production build (standalone)
npm run start # Start production server
npm run format # Prettier write
npm run format:check # Prettier check- Create an MDX file in the appropriate
content/subdirectory - Add the page to the corresponding
_meta.jsfile - Use relative links for cross-references
Dynamic catch-all route at app/[[...mdxPath]]/page.tsx. Every MDX file in content/ automatically gets a corresponding URL:
/->content/index.mdx/getting-started/installation->content/getting-started/installation.mdx/components/tools->content/components/tools.mdx
Static params are generated at build time via Nextra's generateStaticParamsFor().
docker build -t dojops-doc .
docker run -p 3000:3000 dojops-docMulti-stage build (node:20-slim): deps -> builder -> runner. Non-root user (nextjs:1001), standalone output, port 3000.
| Repo | Description |
|---|---|
| dojops/dojops | Main monorepo, CLI, API, all @dojops/* packages |
| dojops/dojops.ai | Marketing website |
| dojops/dojops-hub | Tool marketplace |
MIT