DocOps System

A modern, comprehensive documentation operations system with full toolchain integration for Python, TypeScript, and cloud-native development.

🚀 Features

• Modern Stack: Python 3.13+ with uv, TypeScript with bun
• Cloud-First: Cloudflare Workers, KV, D1, R2 + Vercel/Supabase
• Quality Tools: ruff, mypy, biome, vitest
• CLI Integration: GitHub, Vercel, Terraform, Supabase CLIs
• GitHub Native: Issue templates, PR templates, Actions workflows
• AI Ready: OpenAI integration as standard
• Multi-Language: Ready for Rust and Go when needed

📁 Repository Contents

Core Files

• starter.md - Complete DocOps configuration reference
• docops-modern-stack.md - Modern toolchain configuration
• docops-init-modern.sh - Interactive project initialization script
• DOCOPS-COMPLETE-GUIDE.md - Comprehensive implementation guide

Configuration Templates

• docs/project.profile.modern.json - Modern project profile template
• .github/ - GitHub issue templates, workflows, and configuration
• scripts/ - Automation and CLI management scripts

Documentation

• github-setup.md - GitHub and CLI tools setup guide
• docops-generic-setup.md - Generic project structure guide
• no-drift.md - Configuration drift fixes
• docs/AGENTS.md - Agent operating model

🛠️ Quick Start

1. Install CLI Tools

# Install all required CLI tools
bash scripts/install-cli-tools.sh

# Verify installation
bash scripts/verify-toolchain.sh

2. Initialize New Project

# Run the interactive initialization
bash docops-init-modern.sh

# Follow prompts to configure:
# - Project type (Full-stack, API, Frontend, Workers, CLI)
# - Backend choice (FastAPI, Next.js API, Supabase Functions)
# - Frontend choice (React/Vite, Next.js, SvelteKit)
# - Auth provider (Supabase, Custom JWT, Auth0)
# - Optional: Rust/Go preparation

3. Configure Project

# Copy environment template
cp .env.example .env

# Edit configuration
vim .env

# Setup secrets with gopass
gopass init
gopass insert project/dev/database_url

4. Start Development

# Run all checks
make setup
make ci

# Start development
make dev

📋 Available Commands

Development

make dev           # Run all development servers
make dev-api       # Run Python API
make dev-web       # Run web frontend
make dev-worker    # Run Cloudflare Worker

Code Quality

make format        # Format all code
make lint          # Lint all code
make test          # Run all tests
make ci            # Run complete CI checks

DocOps

make docops:validate   # Validate documentation
make docops:triage     # Classify documents
make docops:sot        # Generate source-of-truth
make docops:all        # Run all DocOps checks

CLI Management

./scripts/project-cli.sh repo:create <name>    # Create GitHub repo
./scripts/project-cli.sh vercel:deploy         # Deploy to Vercel
./scripts/project-cli.sh cf:deploy             # Deploy Workers
./scripts/project-cli.sh supabase:migrate      # Run migrations
./scripts/project-cli.sh setup:all             # Setup everything

🏗️ Project Structure

project/
├── apps/               # Applications
│   ├── api/           # Python backend (FastAPI/Django)
│   ├── web/           # TypeScript frontend
│   ├── workers/       # Cloudflare Workers
│   └── cli/           # CLI tools (Python/Rust/Go)
├── packages/          # Shared packages
│   ├── types/         # TypeScript types
│   ├── utils/         # Shared utilities
│   └── schemas/       # Data schemas
├── docs/              # Documentation
│   ├── project.profile.json  # Project configuration
│   ├── dev/           # Development docs
│   ├── ops/           # Operations docs
│   └── _generated/    # Auto-generated docs
├── tools/             # Build and dev tools
├── scripts/           # Automation scripts
├── policies/          # OPA policies
└── .github/           # GitHub configuration

🔧 Technology Stack

Languages & Runtimes

• Python 3.13+ via uv (fast package management)
• TypeScript 5.6+ via bun (runtime & bundler)
• Rust (optional, cargo)
• Go (optional, go mod)

Quality Tools

• Python: ruff (linting/formatting), mypy (types), pytest (testing)
• TypeScript: biome (linting/formatting), vitest (testing)
• Docs: markdownlint, markdown-link-check

Infrastructure

• Cloudflare: Workers, Pages, KV, D1, R2
• Vercel: Frontend hosting
• Supabase: Database, Auth, Storage
• GitHub: Version control, CI/CD, project management

CLI Tools

• gh - GitHub CLI
• vercel - Vercel deployments
• wrangler - Cloudflare Workers
• terraform - Infrastructure as Code
• supabase - Backend services
• gopass - Secret management

📚 Documentation

• Complete Guide - Full implementation details
• Modern Stack - Technology choices explained
• GitHub Setup - Repository configuration
• Starter Reference - Core DocOps patterns

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run quality checks: make ci
5. Submit a pull request

📄 License

MIT License - See LICENSE file for details

🔗 Links

• Documentation
• Issues
• Discussions

🏷️ Topics

docops documentation python typescript cloudflare automation developer-tools cli github vercel supabase

---

Built with ❤️ for modern development teams