docs: reorganize and consolidate documentation#342
Merged
ngjunsiang merged 1 commit intoweeklyfrom Feb 3, 2026
Merged
Conversation
- Move AGENTS.md to project root for better discoverability - Create TESTING-GUIDE.md merging test-plan.md content - Refactor docs by purpose to eliminate duplication: - GETTING-STARTED: Navigation + installation only - CONTRIBUTING: Workflow/process + code review checklist - STYLE-GUIDE: Coding standards + import conventions - development-guidelines: Architecture patterns + doc standards - TESTING-GUIDE: Complete testing guide with decision tree - PACKAGING: Build/distribution only (removed workflow) - Fix README.md Quick Start command syntax - Fix broken emoji rendering in architecture.md - Update all cross-references to point to correct files Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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
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
This PR reorganizes the Campus documentation to eliminate duplication and improve clarity for both human and AI contributors.
Changes
File Structure
docs/AGENTS.md→AGENTS.md(project root for better discoverability)docs/TESTING-GUIDE.md(merges content from deleteddocs/test-plan.md)docs/test-plan.md(content merged into TESTING-GUIDE.md)Document Refactoring
Each document now has a single, well-defined purpose:
AGENTS.mdGETTING-STARTED.mdCONTRIBUTING.mdSTYLE-GUIDE.mddevelopment-guidelines.mdTESTING-GUIDE.mdPACKAGING.mdKey Improvements
Test Plan
🤖 Generated with Claude Code