Code Editor

Git Workflow for Code Editor

Collaborate on documentation using Git workflows with Documentation.AI

Git Workflow for Code Editor

Use Git for collaboration and version control when working on Documentation.AI projects. Changes pushed to your connected repository automatically trigger builds and deployments.

Documentation Git Workflow

Basic Workflow

Documentation.AI connects to your Git repository and automatically builds when you push changes:

Edit content in your code editor
Commit changes with descriptive messages
Push to your repository
Documentation.AI builds and deploys automatically

Repository Setup

# Clone your connected repository
git clone https://github.com/your-org/docs.git
cd docs

Repository structure:

docs/
├── documentation.json    # Site configuration 
├── getting-started/
│   └── introduction.mdx
└── api/
    └── authentication.mdx

Branching for Documentation

Feature Branch Workflow

Use branches for documentation changes:

# Create feature branch
git checkout -b add-webhook-guide

# Edit documentation files
# Make changes in your editor

# Commit and push
git add .
git commit -m "Add webhook setup guide"
git push origin add-webhook-guide

Branch Naming

Use descriptive branch names:

add-api-docs - New documentation
update-quickstart - Content updates
fix-broken-links - Bug fixes
restructure-nav - Navigation changes

Committing Changes

Commit Messages

Write clear, descriptive commit messages:

# Good examples
git commit -m "Add OAuth authentication guide"
git commit -m "Fix broken links in API section"
git commit -m "Update quickstart with new examples"

# Avoid
git commit -m "Update docs"    # Too vague
git commit -m "WIP"           # Not descriptive

Using Editor Git Features

VS Code: Use Source Control panel (Ctrl+Shift+G)
Cursor: Use built-in Git panel with AI-suggested commit messages

Review changes in diff view
Stage specific files
Write descriptive commit messages
Push directly from editor

AI-Enhanced Workflow: If you're using AI coding agents like Cursor or Windsurf to help write documentation, use our helpful prompts to generate content that follows Documentation.AI conventions and includes proper component formatting.