Dango Documentation Website

Official documentation for Dango - Open Source Data Platform

Status: In Development

• Live URL: https://docs.getdango.dev (coming soon)
• Framework: MkDocs Material
• Deployment: Cloudflare Pages
• Design: Teal (#14B8A6) and Indigo (#6366F1) matching getdango.dev

# Install dependencies
pip install -r requirements.txt

# Serve locally
mkdocs serve

# Build site
mkdocs build

For complete contributor guidelines, see CONTRIBUTING.md

Branch Protection:

• main branch is protected
• All changes must go through Pull Requests
• Force pushes are blocked

Branch Naming Convention:

Format: <type>/<date>-<description>

Types:

• feature/ - New features or major additions (e.g., new documentation sections)
• fix/ - Bug fixes or corrections
• docs/ - Documentation updates or improvements
• chore/ - Maintenance tasks (dependencies, tooling, CI/CD)
• refactor/ - Restructuring without changing functionality

Examples:

• feature/2025-12-08-getting-started-section
• feature/2025-12-08-data-sources-docs
• fix/2025-12-09-broken-links-homepage
• docs/2025-12-09-update-installation-guide
• chore/2025-12-10-update-mkdocs-version

Workflow Steps:

1. Pull latest main:

   git checkout main
   git pull origin main

2. Create feature branch:

   git checkout -b feature/$(date +%Y-%m-%d)-your-feature-name

3. Make changes and commit:

   git add .
   git commit -m "Your descriptive commit message"

4. Push to remote:

   git push -u origin $(git branch --show-current)

5. Create Pull Request:

   • Go to https://github.com/getdango/docs
   • Click "New Pull Request"
   • Select your branch
   • Fill in PR description
   • Request review

6. After PR is merged:

   git checkout main
   git pull origin main
   git branch -d <your-branch-name>

• Use imperative mood ("Add feature" not "Added feature")
• Keep first line under 72 characters
• Reference issues when applicable: "Fix navigation bug (#123)"
• Use clear, descriptive messages

Examples:

• Add Getting Started section
• Fix broken links in installation guide
• Update mkdocs.yml configuration
• Refactor navigation structure

See ../DOCS_WEBSITE_PLAN.md for the complete implementation plan.

• Main Application: https://github.com/getdango/dango
• Marketing Website: https://github.com/getdango/website

Last Updated: December 8, 2025