Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (43 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

58 lines (43 loc) · 1.66 KB

Contributing

Contributions to DojOps Docs are welcome! This is the documentation site for the DojOps ecosystem, built with Nextra.

Development Setup

git clone https://github.com/dojops/dojops-doc.git
cd dojops-doc
npm install
npm run dev   # Start dev server with hot reload

Available Commands

npm run dev           # Next.js dev server
npm run build         # Production build
npm run format        # Prettier write
npm run format:check  # Prettier check

Content Structure

All documentation lives in content/ as MDX files. Navigation is controlled by _meta.js files in each directory.

content/
├── getting-started/   # Installation, Quick Start, Configuration, Providers
├── usage/             # CLI Reference, API Reference, Web Dashboard
├── architecture/      # System Design, Security Model
├── components/        # Agents, Tools, Tool Spec, Scanning, Executor, Planner
└── community/         # Contributing, Troubleshooting

Writing Guidelines

  • Use MDX for all content files
  • Keep code examples accurate and tested
  • Cross-reference related pages with relative links
  • Update _meta.js when adding new pages

Commit Convention

This repo uses Conventional Commits. Husky enforces this on every commit.

docs: add API token management guide
fix: correct CLI command example
style: format MDX tables

PR Checklist

  • Formatting is correct (npm run format:check)
  • Build succeeds (npm run build)
  • Links are valid and point to correct pages
  • Code examples are accurate