docs: complete documentation rewrite v3.5.0 #420
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Delete 41 design docs from docs/ (~540KB removed) - Create new VitePress structure: getting-started/, user-guide/, developer-guide/ - Add 17 comprehensive documentation pages - Simplify README.md (650 → 149 lines) - Add scripts/sync-docs.js for docs mirroring - Update VitePress config with navigation and sidebar - Remove duplicate directories (guide/, development/, architecture/)
Contributor
There was a problem hiding this comment.
Pull request overview
This PR represents a complete documentation rewrite for ClaudeAutoPM v3.5.0, eliminating duplication by removing 41 legacy design documents (~540KB) and establishing a clean VitePress documentation structure with 17 comprehensive new pages organized into getting-started/, user-guide/, and developer-guide/ sections.
Key Changes
- Removed 41 outdated design documents from
docs/directory - Created structured VitePress documentation site with three main sections
- Added comprehensive user and developer guides (17 new documentation pages)
- Simplified README.md from 650 to 149 lines
Reviewed changes
Copilot reviewed 51 out of 111 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/OPCJA-3-SUMMARY.md | Deleted legacy implementation summary document |
| docs/MISSING-COMMANDS-ANALYSIS.md | Removed command analysis that is now outdated |
| docs/INSTALL.md | Removed generic installation guide replaced by detailed VitePress docs |
| docs/HOW-TOKENS-REALLY-WORK.md | Deleted token analysis document no longer relevant |
| docs/GITHUB-TESTING-GUIDE.md | Removed testing guide superseded by new documentation |
| docs/FAQ.md | Deleted generic FAQ replaced by comprehensive guides |
| docs/EPIC-DECOMPOSE-QUICK-GUIDE.md | Removed quick guide now covered in user guide |
| docs/EPIC-COMMANDS-GUIDE.md | Deleted command guide replaced by structured command reference |
| docs/CONTEXT7-VALIDATION.md | Removed validation document no longer needed |
| docs/CONTEXT-HYGIENE-STRATEGY.md | Deleted strategy document superseded by best practices |
| docs/CONFLICT-RESOLUTION.md | Removed conflict resolution guide now in reference docs |
| docs/CONFIG.md | Deleted generic config guide replaced by detailed configuration docs |
| docs/COMMAND-INSTRUCTIONS-FIX.md | Removed fix documentation that is historical |
| docs/CLI-vs-CLAUDE-CODE.md | Deleted comparison document now covered in getting started |
| docs/CCPM-COMPARISON.md | Removed comparison analysis document |
| docs/AZURE-TESTING-GUIDE.md | Deleted Azure testing guide superseded by Azure DevOps integration docs |
| docs/AGENT-TASK-CREATION-ENHANCEMENT.md | Removed enhancement document that is historical |
| docs-site/docs/user-guide/pm-workflow.md | New comprehensive PM workflow documentation |
| docs-site/docs/user-guide/mcp-servers.md | New MCP servers integration guide |
| docs-site/docs/user-guide/index.md | New user guide index and overview |
| docs-site/docs/user-guide/commands-overview.md | New complete commands reference |
| docs-site/docs/user-guide/best-practices.md | New best practices guide |
| docs-site/docs/user-guide/agents-overview.md | New agents usage guide |
| docs-site/docs/getting-started/installation.md | New comprehensive installation guide |
| docs-site/docs/getting-started/index.md | New getting started overview |
| docs-site/docs/getting-started/first-project.md | New hands-on tutorial |
| docs-site/docs/getting-started/configuration.md | New configuration guide |
| docs-site/docs/developer-guide/index.md | New developer guide overview |
Comments suppressed due to low confidence (1)
docs-site/docs/getting-started/first-project.md:1
- The workflow table shows step 6 using issue number '123', but this number is not explained or shown being created in earlier steps. Consider using a placeholder like
<issue-number>or referencing that this comes from the sync step output.
---
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| |-------------|-----------------| | ||
| | Node.js | >= 16.0.0 | | ||
| | npm | >= 8.0.0 | | ||
| | Git | Latest stable | |
There was a problem hiding this comment.
Specify a minimum Git version requirement for consistency with other prerequisites. Instead of 'Latest stable', provide a concrete minimum version like '>= 2.0.0' or similar.
Suggested change
| | Git | Latest stable | | |
| | Git | >= 2.0.0 | |
| - Breaking changes are not reflected in older models | ||
|
|
||
| **Usage**: | ||
| ```bash |
There was a problem hiding this comment.
The usage example shows 'mcp://context7/react/hooks' but doesn't indicate this is a query format rather than a command. Add clarifying text like '# Use in agent queries:' or '# Query format:' to make the context clearer.
Suggested change
| ```bash | |
| ```bash | |
| # Query format (for use in agent queries, not a shell command) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Complete documentation rewrite eliminating duplication and creating clean VitePress structure.
Changes
Files Changed
Documentation Structure
Test Plan