App Repo (Merge/Release) ──→ DocFlow Git Analyzer
                                    │
                                    ▼
                          Prompt Builder (Jinja2)
                                    │
                         Caveman Task Prompt
                                    │
                                    ▼
                           Agent Runner (shell / manual)
                                    │
                                    ▼
                         Target Docs Repository
                          ├── architecture/ (Hosting & Frameworks) [Init First]
                          ├── features/<feature>/
                          │     ├── index.md (Human)
                          │     └── context.json (LLM)
                          ├── status/ (wip.md, wip.json)
                          ├── prompts/ (pending/ & completed/)
                          ├── llms.txt & llms-full.txt
                          └── CONVENTIONS.md
                                    │
                                    ▼
                         Doc Branch & MR Creator
                                    │
                                    ▼
                           FastMCP Server
                          (stdio / SSE transports)

# Clone the repository
git clone https://github.com/YOUR_USERNAME/docflow2.git
cd docflow2

# Create a virtual environment (recommended for Linux/PEP 668)
python3 -m venv --without-pip .venv
curl -sS https://bootstrap.pypa.io/get-pip.py | .venv/bin/python3

# Install DocFlow in editable mode
.venv/bin/pip install -e .

# Activate the virtual environment
source .venv/bin/activate

# 1. Initialize documentation for an application repository
docflow init --repo /path/to/app-repo --docs /path/to/docs-repo --mode manual

# 2. Track active feature branches & work-in-progress
docflow status --repo /path/to/app-repo --docs /path/to/docs-repo

# 3. Generate documentation update prompts from git diffs
docflow generate --repo /path/to/app-repo --docs /path/to/docs-repo --from main~1 --to main

# 4. Commit doc updates, push branch, and create Pull Request
docflow publish --docs /path/to/docs-repo --platform github

# 5. Start the MCP Server for LLM agent integration
docflow serve --docs /path/to/docs-repo --mode stdio

docs-repo/
├── CONVENTIONS.md                        # Documentation format standards
├── llms.txt                              # Discovery index
├── llms-full.txt                         # Concatenated context file
│
├── architecture/                         # Baseline architecture & infrastructure
│   ├── index.md                          # Frameworks, Dev/Staging/Prod envs
│   └── context.json                      # Compact LLM metadata
│
├── features/                             # Feature-based documentation
│   ├── authentication/
│   │   ├── index.md                      # Detailed human docs
│   │   ├── context.json                  # Compact LLM JSON
│   │   ├── files.md                      # File manifest
│   │   └── changelog.md                  # Historical change log
│   └── ...
│
├── status/                               # Work-in-progress active branch docs
│   ├── wip.md
│   └── wip.json
│
└── prompts/                              # Task prompt repository
    ├── pending/                          # Prompts waiting for agent execution
    └── completed/                        # Completed task prompts (audit log)

project:
  name: "MyApplication"

app:
  repo_path: "/path/to/app-repo"

docs:
  repo_path: "/path/to/docs-repo"

agent:
  mode: "shell"                          # "shell" (automatic CLI agent execution) or "manual" (stage prompts in prompts/pending/)
  command: "agy --dangerously-skip-permissions --add-dir {docs_repo} -p \"$(cat {prompt_file})\""

platform:
  type: "github"                         # github | gitlab | bitbucket | generic
  auto_mr: true

generation:
  full_diff_threshold: 200
  ignore:
    - "*.lock"
    - "node_modules/"
    - "dist/"
    - "__pycache__/"

docflow info

DocFlow Information Dashboard
  Project Name: MyApplication
  App Repo:     /path/to/app-repo (exists)
  Docs Repo:    /path/to/docs-repo (exists)
  Agent Mode:   shell (agy --dangerously-skip-permissions --add-dir {docs_repo} -p "$(cat {prompt_file})")
  Platform:     github
  Documented Features (7): config, core, components, scripts, public, pages, lib
  Pending Prompts (0): None

pytest -v