https://github.com/dojops/dojops-doc
DojOps Documentation website
https://github.com/dojops/dojops-doc
Last synced: 23 days ago
JSON representation
DojOps Documentation website
- Host: GitHub
- URL: https://github.com/dojops/dojops-doc
- Owner: dojops
- License: mit
- Created: 2026-03-01T13:09:19.000Z (30 days ago)
- Default Branch: main
- Last Pushed: 2026-03-05T20:05:30.000Z (25 days ago)
- Last Synced: 2026-03-06T05:04:00.144Z (25 days ago)
- Language: MDX
- Homepage: https://doc.dojops.ai
- Size: 4.93 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
DojOps Documentation
Official documentation for DojOps — the AI DevOps Automation Engine.
Live: docs.dojops.ai
## Tech Stack
- **Next.js 15.1** (App Router, standalone output)
- **Nextra 4.2** + **nextra-theme-docs** (MDX documentation framework)
- **React 19** + **TypeScript 5.7**
## Content
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 # 16 built-in agents + custom agents
│ ├── tools.mdx # 12 DevOps tools + custom tool 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.
## Theme
Configured in `app/layout.tsx`:
- **Navbar**: DojOps logo + GitHub project link
- **Banner**: Promotional link to [dojops.ai](https://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
## Development
### Prerequisites
- Node.js >= 20
### Setup
```bash
git clone https://github.com/dojops/dojops-doc.git
cd dojops-doc
npm install
npm run dev
```
### Commands
```bash
npm 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
```
### Adding a Page
1. Create an MDX file in the appropriate `content/` subdirectory
2. Add the page to the corresponding `_meta.js` file
3. Use relative links for cross-references
## Routing
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
```bash
docker build -t dojops-doc .
docker run -p 3000:3000 dojops-doc
```
Multi-stage build (node:20-slim): deps -> builder -> runner. Non-root user (`nextjs:1001`), standalone output, port 3000.
## Related Repos
| Repo | Description |
| --------------------------------------------------------- | ------------------------------------------------- |
| [dojops/dojops](https://github.com/dojops/dojops) | Main monorepo — CLI, API, all @dojops/\* packages |
| [dojops/dojops.ai](https://github.com/dojops/dojops.ai) | Marketing website |
| [dojops/dojops-hub](https://github.com/dojops/dojops-hub) | Tool marketplace |
## License
MIT