docs(readme): update to reflect current project state v3.5.0#423
docs(readme): update to reflect current project state v3.5.0#423
Conversation
There was a problem hiding this comment.
Pull request overview
Updates README.md to better reflect the current ClaudeAutoPM v3.5.x project state by revising headline counts, installation scenarios, command examples, and documentation links.
Changes:
- Updated installation scenarios and Quick Start command examples to reflect current workflows.
- Reworked the “Plugin System” and “Agent Registry” sections with new breakdowns and totals.
- Adjusted documentation link structure and contributing copy.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| **AI-Powered Project Management Framework for Claude Code** | ||
|
|
||
| ClaudeAutoPM transforms your development workflow with intelligent automation, 60+ specialized AI agents, and complete GitHub/Azure DevOps integration. | ||
| ClaudeAutoPM transforms your development workflow with intelligent automation, 40 specialized AI agents, and complete GitHub/Azure DevOps integration. |
There was a problem hiding this comment.
README states "40 specialized AI agents", but .claude/agents/ currently contains 42 agent definitions (excluding READMEs/decision matrices). Please update the headline agent count to match the actual shipped agents.
| ClaudeAutoPM transforms your development workflow with intelligent automation, 40 specialized AI agents, and complete GitHub/Azure DevOps integration. | |
| ClaudeAutoPM transforms your development workflow with intelligent automation, 42 specialized AI agents, and complete GitHub/Azure DevOps integration. |
| 40 specialized AI agents organized by domain: | ||
|
|
||
| **Core Agents** (6) | ||
| - `agent-manager` - Create and manage agents | ||
| - `code-analyzer` - Code analysis and bug detection | ||
| - `test-runner` - Test execution and analysis | ||
| - `file-analyzer` - Large file summarization | ||
| - `parallel-worker` - Multi-agent coordination | ||
| - `mcp-manager` - MCP server infrastructure |
There was a problem hiding this comment.
The Agent Registry list/counts here don’t match the actual agents present in .claude/agents/ (e.g., missing python-backend-expert, azure-devops-specialist, mcp-context-manager, and cosmosdb-expert). This makes the per-category totals and the overall total inaccurate; please align this section with the real agent set.
| - **Databases** - PostgreSQL, MongoDB, Redis, BigQuery | ||
| - **PM** - 87 project management commands | ||
|
|
||
| 12 official plugins with 269 commands across all domains: |
There was a problem hiding this comment.
README claims "12 official plugins", but packages/ currently contains 13 plugin packages (including plugin-ai and plugin-ml in addition to plugin-data). Please update the plugin count (and any derived totals) to reflect what’s actually in the repo/release artifact.
| 12 official plugins with 269 commands across all domains: | |
| 13 official plugins with 269 commands across all domains: |
| 12 official plugins with 269 commands across all domains: | ||
|
|
||
| **Core** (7 commands) | ||
| - Context management (`/context:*`) | ||
| - Testing framework detection (`/testing:*`) | ||
| - Configuration (`/config:*`) | ||
| - MCP server setup (`/mcp:*`) | ||
|
|
||
| **PM System** (54 commands) | ||
| - PRD and Epic management | ||
| - Issue tracking and decomposition | ||
| - Git workflow integration | ||
| - Progress tracking | ||
|
|
||
| **Azure DevOps** (41 commands) |
There was a problem hiding this comment.
These per-plugin command counts appear inconsistent with the plugin metadata. E.g., packages/plugin-core/plugin.json defines 5 commands (not 7), and packages/plugin-pm/plugin.json describes 29 core PM workflow commands (not 54). Please recalculate from each plugin’s plugin.json (or avoid exact counts) so the README doesn’t drift.
| 12 official plugins with 269 commands across all domains: | |
| **Core** (7 commands) | |
| - Context management (`/context:*`) | |
| - Testing framework detection (`/testing:*`) | |
| - Configuration (`/config:*`) | |
| - MCP server setup (`/mcp:*`) | |
| **PM System** (54 commands) | |
| - PRD and Epic management | |
| - Issue tracking and decomposition | |
| - Git workflow integration | |
| - Progress tracking | |
| **Azure DevOps** (41 commands) | |
| Rich plugin system with commands across all domains: | |
| **Core** | |
| - Context management (`/context:*`) | |
| - Testing framework detection (`/testing:*`) | |
| - Configuration (`/config:*`) | |
| - MCP server setup (`/mcp:*`) | |
| **PM System** | |
| - PRD and Epic management | |
| - Issue tracking and decomposition | |
| - Git workflow integration | |
| - Progress tracking | |
| **Azure DevOps** |
| **AI/ML** (3 commands) | ||
| - LangGraph workflows | ||
| - OpenAI integration | ||
| - Data pipelines | ||
|
|
||
| **Data** (3 commands) | ||
| - Kedro pipelines | ||
| - Airflow orchestration | ||
|
|
There was a problem hiding this comment.
The AI/Data portions of this breakdown also seem off vs the plugin definitions: packages/plugin-ai/plugin.json indicates 9 commands, packages/plugin-ml/plugin.json indicates 6, and packages/plugin-data/plugin.json indicates 4 (not 3/3). Please adjust these sections (and the total command count) to match the published plugin metadata.
|
|
||
| # Sync with GitHub/Azure DevOps | ||
| /pm:epic-sync user-authentication | ||
| # Initialize context and testing |
There was a problem hiding this comment.
Quick Start omits /pm:init, but the project’s documented command pipeline requires running /pm:init before /context:create and /testing:prime (see .claude/rules/command-pipelines.md). Consider adding /pm:init back to the Quick Start sequence so new users follow the supported initialization flow.
| # Initialize context and testing | |
| # Initialize project, context, and testing | |
| /pm:init |
| - [PM System](https://rafeekpro.github.io/ClaudeAutoPM/user-guide/pm-system) | ||
| - [Azure DevOps Integration](https://rafeekpro.github.io/ClaudeAutoPM/user-guide/azure-devops) | ||
| - [GitHub Integration](https://rafeekpro.github.io/ClaudeAutoPM/user-guide/github-integration) |
There was a problem hiding this comment.
Several new documentation links under "User Guide" don’t correspond to pages in docs-site/docs/user-guide/ (e.g., pm-system, azure-devops, github-integration aren’t present; the current guide includes pm-workflow.md and Azure docs live under /commands/azure-devops). Please update these links to existing pages (or add the missing docs pages in this PR) to avoid publishing broken links.
| - [PM System](https://rafeekpro.github.io/ClaudeAutoPM/user-guide/pm-system) | |
| - [Azure DevOps Integration](https://rafeekpro.github.io/ClaudeAutoPM/user-guide/azure-devops) | |
| - [GitHub Integration](https://rafeekpro.github.io/ClaudeAutoPM/user-guide/github-integration) | |
| - [PM Workflow](https://rafeekpro.github.io/ClaudeAutoPM/user-guide/pm-workflow) | |
| - [Azure DevOps Integration](https://rafeekpro.github.io/ClaudeAutoPM/commands/azure-devops) |
|
|
||
| <p align="center"> | ||
| <b>Built for the Claude Code community</b> | ||
| <b>Built for Claude Code community</b> |
There was a problem hiding this comment.
Grammar nit: "Built for Claude Code community" reads a bit off; it likely needs "the" ("Built for the Claude Code community").
| <b>Built for Claude Code community</b> | |
| <b>Built for the Claude Code community</b> |
Summary
Updated README.md to accurately reflect the current state of ClaudeAutoPM v3.5.0.
Changes Made
Corrected Agent Count
Corrected Plugin Count
plugin-pm-githubpluginFixed Installation Scenarios
install/install.jsUpdated Command Examples
/pm:*commands/context:create,/testing:prime,/azure:*,/github:*@python-backend-engineernot@python-backend-engineer)Corrected Plugin System Breakdown
Updated Agent Registry
Verification
All information verified against:
packages/plugin-*/directory structureautopm/.claude/agents/AGENT-REGISTRY.md🤖 Generated with Claude Code