docs: reorganize documentation structure with consistent naming#6
Merged
docs: reorganize documentation structure with consistent naming#6
Conversation
Reorganized all documentation into clear, purpose-based structure: - Root: Minimal MD files (README, CLAUDE, CONTRIBUTING, CHANGELOG) - docs/getting-started/: Installation, quickstart, configuration - docs/guides/: User, developer, testing, git-workflow guides - docs/reference/: Technical reference (schema, data-formats, query-patterns, biography) - docs/projects/: Active feature work (ai-agent, census-extraction, biography-citations) - docs/archive/: Completed milestones and summaries Created docs/INDEX.md as master table of contents. Applied consistent naming: lowercase-with-hyphens.md format. Updated CLAUDE.md and README.md to reference new structure. Moved career-strategy.md out of repository to ~/Code/ai-engineering/. Total changes: 58 files (1 created, 2 modified, 55 moved/renamed) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Added 11 custom slash commands for RMAgent development: - RMAgent-specific commands (rm- prefix): bio, ask, person, search, quality, timeline - Development commands: test, coverage, lint - Utility commands: docs, check-db Created comprehensive Claude Code setup guide at docs/guides/claude-code-setup.md with usage examples, best practices, and troubleshooting. Added Claude Code hooks in .claude/settings.local.json: - PostToolUse: Coverage reminder after pytest with --cov - PreToolUse: Show recent commits before git push Moved AGENTS.md from docs/archive/summaries/ back to root directory for better visibility and standard location alongside CLAUDE.md. Updated docs/INDEX.md with Root Documentation section listing all 5 key files kept in repository root. Updated CLAUDE.md with Claude Code Integration section referencing new slash commands and hooks. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
…ection Added /doc-review slash command with two modes: - Brief mode: Reviews root docs (CLAUDE.md, README.md, AGENTS.md, CONTRIBUTING.md, CHANGELOG.md) and docs/INDEX.md for accuracy and completeness - Deep mode: Reviews ALL documentation files for consistency and currency Updated docs/guides/git-workflow.md to reflect: - Branch protection settings for main (strict) and develop (relaxed) - Three-layer automated check system: 1. Git pre-commit hook (local documentation reminders) 2. Claude Code hooks (coverage/push notifications) 3. GitHub Actions CI/CD (required status checks) - Updated PR checklist with hook references - Added pre-commit hook section with example output - Updated best practices to reference hooks and slash commands Updated docs/guides/claude-code-setup.md: - Added /doc-review command documentation - Updated total command count to 12 - Added /doc-review to "When to Use Each Command" section - Added /doc-review to show-prompt/meta flags section - Added /doc-review test to setup testing section Updated CLAUDE.md: - Updated command count from 11 to 12 - Added /doc-review to quick commands list 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <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
1 participant
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
Comprehensive documentation reorganization to improve discoverability, maintainability, and consistency.
Changes
Directory Structure
schema/- Database schema and structuredata-formats/- RM11 data format specificationsquery-patterns/- SQL patterns and data quality rulesbiography/- Biography generation referenceai-agent/- AI agent roadmap and architecturebiography-citations/- Citation implementation planscensus-extraction/- Census extraction system designcheckpoints/- Phase completion milestonessummaries/- Implementation and optimization summariesNew Files
Naming Convention
Applied consistent
lowercase-with-hyphens.mdformat across all documentation files:INSTALL.md→installation.mdRM11_Schema_Reference.md→schema-reference.mdAI_AGENT_TODO.md→roadmap.mdDocumentation Updates
Files Moved/Renamed
58 files total (55 moved/renamed, 1 created, 2 modified)
Benefits
Test plan
🤖 Generated with Claude Code