{"id":46263364,"url":"https://github.com/dojops/dojops-doc","last_synced_at":"2026-03-08T05:01:20.481Z","repository":{"id":341657802,"uuid":"1169938021","full_name":"dojops/dojops-doc","owner":"dojops","description":"DojOps Documentation website","archived":false,"fork":false,"pushed_at":"2026-03-05T20:05:30.000Z","size":5172,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-06T05:04:00.144Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://doc.dojops.ai","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dojops.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-01T13:09:19.000Z","updated_at":"2026-03-05T20:05:35.000Z","dependencies_parsed_at":"2026-03-06T03:03:24.010Z","dependency_job_id":null,"html_url":"https://github.com/dojops/dojops-doc","commit_stats":null,"previous_names":["dojops/dojops-doc"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dojops/dojops-doc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dojops%2Fdojops-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dojops%2Fdojops-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dojops%2Fdojops-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dojops%2Fdojops-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dojops","download_url":"https://codeload.github.com/dojops/dojops-doc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dojops%2Fdojops-doc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30207389,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T03:24:23.086Z","status":"ssl_error","status_checked_at":"2026-03-07T03:23:11.444Z","response_time":53,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-03-04T01:47:09.768Z","updated_at":"2026-03-08T05:01:20.396Z","avatar_url":"https://github.com/dojops.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"public/icon.png\" alt=\"DojOps Docs\" width=\"80\" /\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eDojOps Documentation\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003eOfficial documentation for \u003ca href=\"https://github.com/dojops/dojops\"\u003eDojOps\u003c/a\u003e\u003c/strong\u003e — the AI DevOps Automation Engine.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003eLive:\u003c/strong\u003e \u003ca href=\"https://docs.dojops.ai\"\u003edocs.dojops.ai\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/next.js-15.1-000?style=flat-square\u0026logo=next.js\" alt=\"Next.js\" /\u003e\n  \u003cimg src=\"https://img.shields.io/badge/nextra-4.2-000?style=flat-square\" alt=\"Nextra\" /\u003e\n  \u003cimg src=\"https://img.shields.io/badge/typescript-5.7-3178c6?style=flat-square\u0026logo=typescript\u0026logoColor=white\" alt=\"TypeScript\" /\u003e\n  \u003cimg src=\"https://img.shields.io/badge/license-MIT-blue?style=flat-square\" alt=\"License\" /\u003e\n\u003c/p\u003e\n\n## Tech Stack\n\n- **Next.js 15.1** (App Router, standalone output)\n- **Nextra 4.2** + **nextra-theme-docs** (MDX documentation framework)\n- **React 19** + **TypeScript 5.7**\n\n## Content\n\n18 MDX pages organized into 6 sections:\n\n```\ncontent/\n├── index.mdx                      # Introduction\n├── getting-started/\n│   ├── installation.mdx           # Prerequisites, npm/curl/Docker install\n│   ├── quickstart.mdx             # First run, basic workflow\n│   ├── configuration.mdx          # Providers, env vars, profiles\n│   └── providers.mdx              # Add, remove, switch LLM providers\n├── usage/\n│   ├── cli.mdx                    # CLI command reference\n│   ├── api.mdx                    # 19 REST endpoints with examples\n│   └── dashboard.mdx              # Web dashboard overview\n├── architecture/\n│   ├── overview.mdx               # System design, package layers, data flow\n│   └── security-model.mdx         # Defense-in-depth, trust boundaries\n├── components/\n│   ├── agents.mdx                 # 16 built-in agents + custom agents\n│   ├── tools.mdx                  # 12 DevOps tools + custom tool system\n│   ├── tool-spec-v1.mdx           # Frozen v1 tool contract\n│   ├── security-scanning.mdx      # 10 scanners, modes, remediation\n│   ├── execution-engine.mdx       # SafeExecutor, policies, audit logging\n│   └── planner.mdx                # Task decomposition, topological execution\n└── community/\n    ├── contributing.mdx            # Dev setup, commit conventions, PR checklist\n    └── troubleshooting.mdx         # FAQ, common issues, debugging\n```\n\nNavigation is controlled by `_meta.js` files in each directory.\n\n## Theme\n\nConfigured in `app/layout.tsx`:\n\n- **Navbar**: DojOps logo + GitHub project link\n- **Banner**: Promotional link to [dojops.ai](https://dojops.ai) (dismissible)\n- **Sidebar**: Collapsible, first level expanded by default\n- **Footer**: MIT license + copyright\n- **Edit link**: \"Edit this page on GitHub\" pointing to this repo\n- **Metadata**: Title template `%s — DojOps Docs`, favicon\n\n## Development\n\n### Prerequisites\n\n- Node.js \u003e= 20\n\n### Setup\n\n```bash\ngit clone https://github.com/dojops/dojops-doc.git\ncd dojops-doc\nnpm install\nnpm run dev\n```\n\n### Commands\n\n```bash\nnpm run dev            # Dev server with hot reload (http://localhost:3000)\nnpm run build          # Production build (standalone)\nnpm run start          # Start production server\nnpm run format         # Prettier write\nnpm run format:check   # Prettier check\n```\n\n### Adding a Page\n\n1. Create an MDX file in the appropriate `content/` subdirectory\n2. Add the page to the corresponding `_meta.js` file\n3. Use relative links for cross-references\n\n## Routing\n\nDynamic catch-all route at `app/[[...mdxPath]]/page.tsx`. Every MDX file in `content/` automatically gets a corresponding URL:\n\n- `/` -\u003e `content/index.mdx`\n- `/getting-started/installation` -\u003e `content/getting-started/installation.mdx`\n- `/components/tools` -\u003e `content/components/tools.mdx`\n\nStatic params are generated at build time via Nextra's `generateStaticParamsFor()`.\n\n## Docker\n\n```bash\ndocker build -t dojops-doc .\ndocker run -p 3000:3000 dojops-doc\n```\n\nMulti-stage build (node:20-slim): deps -\u003e builder -\u003e runner. Non-root user (`nextjs:1001`), standalone output, port 3000.\n\n## Related Repos\n\n| Repo                                                      | Description                                       |\n| --------------------------------------------------------- | ------------------------------------------------- |\n| [dojops/dojops](https://github.com/dojops/dojops)         | Main monorepo — CLI, API, all @dojops/\\* packages |\n| [dojops/dojops.ai](https://github.com/dojops/dojops.ai)   | Marketing website                                 |\n| [dojops/dojops-hub](https://github.com/dojops/dojops-hub) | Tool marketplace                                  |\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdojops%2Fdojops-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdojops%2Fdojops-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdojops%2Fdojops-doc/lists"}