Skip to content

[plan] Implement Documentation Maintainer workflow #334

@github-actions

Description

@github-actions

Objective

Create a daily workflow that reviews documentation files (16+ docs) and creates PRs to keep them synchronized with code changes.

Context

The repository has 16+ documentation files (/docs/, README.md, AGENTS.md) that drift out of sync with code. Recent examples:

  • PR feat: remove Docker-in-Docker support #205 removed Docker-in-Docker but MCP configuration docs still referenced it
  • Architecture changes to iptables rules aren't reflected in security documentation
  • CLI flag additions aren't consistently documented

As a security-critical tool, accurate documentation is essential for safe usage.

Approach

  1. Create workflow file: .github/workflows/doc-maintainer.md
  2. Configure triggers:
    • Daily schedule
    • Manual workflow_dispatch
  3. Review recent changes: Analyze git commits from past 7 days
  4. Identify documentation gaps:
    • Architecture changes (Docker, containers, networking)
    • API changes (CLI flags, env vars, configuration options)
    • Usage examples (MCP setup, firewall rules, domain whitelisting)
    • Security guidance (capabilities, iptables, Squid config)
  5. Create PR with updates:
    • Focus on critical docs first: /docs/mcp-config.md, README.md, AGENTS.md
    • Ensure code examples execute correctly
    • Update version numbers when applicable
    • Keep examples minimal and focused

Files to Create/Modify

Priority Documentation Files

  1. /docs/mcp-config.md - MCP server configuration (CRITICAL - frequently outdated)
  2. /docs/architecture.md - Container and network architecture
  3. /docs/usage.md - CLI usage and examples
  4. README.md - Overview and quick start
  5. AGENTS.md - Agent development guidelines
  6. /docs/logging.md - Logging configuration

Acceptance Criteria

  • Workflow runs daily at scheduled time
  • Reviews git commits from past 7 days
  • Identifies documentation that needs updates
  • Creates PR with synchronized documentation
  • Verifies code examples are valid
  • Completes within 15 minutes timeout
  • Labels PRs with documentation, ai-generated

Success Metrics

AI generated by Plan Command for discussion #328

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions