Skip to content

Commit 175691c

Browse files
jacoponeclaude
andcommitted
docs: reorganize documentation with clear category separation
Phase 2 documentation cleanup - restructured docs/ directory for better organization and discoverability. New Structure: - docs/architecture/ - System architecture documentation - Moved CLAUDE_ORCHESTRATION.md from root to architecture/ - docs/guides/ - User guides and how-tos - Contains COMMON_TASKS.md for quick reference - docs/integrations/ - External system integrations - Moved CURSOR_AI_QUALITY_INTEGRATION.md from docs/ root - docs/automation/ - Automation systems documentation - Contains claude-automation-system.md and refactoring plans - docs/planning/ - Future plans and proposals - active/ - Active planning documents (HN_LAUNCH_PLAN.md) - archive/ - Completed plans (empty for now) - docs/tools/ - Tool-specific guides (unchanged) - fish-smart-commands.md, enhanced-tools-guide.md, etc. - docs/archive/ - Historical documentation - Moved DOCUMENTATION_AUDIT_2025-10-06.md here - Contains claude-automation-system-OLD.md Link Updates: - Updated README.md: - Repository structure diagram reflects new organization - Documentation section reorganized with new categories - Added User Guides subsection - Removed obsolete scripts/ section from diagram - Updated docs/automation/claude-automation-system.md: - Fixed link to CLAUDE_ORCHESTRATION.md (now in architecture/) - Updated templates/README.md: - Fixed link to CURSOR_AI_QUALITY_INTEGRATION.md (now in integrations/) Benefits: - Clear separation of concerns (architecture vs guides vs planning) - Easier to find relevant documentation - Scalable structure for future docs - Active vs archived planning documents separated - Historical documentation preserved but segregated 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 0b8e382 commit 175691c

File tree

8 files changed

+50
-27
lines changed

8 files changed

+50
-27
lines changed

CHANGELOG.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,26 @@ Format based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
2626
- Fish abbreviations increased to 58
2727

2828
### Documentation
29-
- Updated CLAUDE_ORCHESTRATION.md to reflect claude-automation extraction (2025-10-03)
30-
- Updated README.md automation reference to external repository
31-
- Deprecated docs/automation/claude-automation-system.md with redirect to external repo
32-
- Created docs/archive/ directory for historical documentation
33-
- Deleted empty templates/ai-quality-devenv/ directory (superseded by ai-project-orchestration)
29+
- **Phase 1: Fixed Stale References**
30+
- Updated CLAUDE_ORCHESTRATION.md to reflect claude-automation extraction (2025-10-03)
31+
- Updated README.md automation reference to external repository
32+
- Deprecated docs/automation/claude-automation-system.md with redirect to external repo
33+
- Deleted empty templates/ai-quality-devenv/ directory (superseded by ai-project-orchestration)
34+
- Added comprehensive documentation audit report
35+
36+
- **Phase 2: Documentation Reorganization**
37+
- Restructured docs/ with clear category separation:
38+
- `docs/architecture/` - System architecture (CLAUDE_ORCHESTRATION.md)
39+
- `docs/guides/` - User guides (COMMON_TASKS.md)
40+
- `docs/integrations/` - External integrations (CURSOR_AI_QUALITY_INTEGRATION.md)
41+
- `docs/automation/` - Automation systems
42+
- `docs/planning/active/` - Active plans (HN_LAUNCH_PLAN.md)
43+
- `docs/planning/archive/` - Completed plans
44+
- `docs/tools/` - Tool-specific guides
45+
- `docs/archive/` - Historical documentation
46+
- Updated all internal markdown links to reflect new structure
47+
- Updated README.md repository structure diagram
48+
- Added User Guides section to documentation index
3449

3550
---
3651

README.md

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -101,30 +101,33 @@ nixos-config/
101101
│ ├── deprecated/ # Postmortems and cost savings
102102
│ ├── automation/ # Cost calculator and review scripts
103103
│ └── chrome-profiles/ # Chrome multi-profile strategy
104-
├── 📁 scripts/
105-
│ ├── claude-automation/ # CRITICAL: Claude Code auto-generation system
106-
│ │ ├── generators/ # System and project CLAUDE.md generators
107-
│ │ ├── parsers/ # Nix configuration parsers
108-
│ │ ├── templates/ # Jinja2 templates for auto-generation
109-
│ │ ├── validators/ # Content validation
110-
│ │ └── README.md # DO NOT DELETE - see CLAUDE_ORCHESTRATION.md
111-
│ ├── update-system-claude-v2.py # System-level Claude Code automation engine
112-
│ ├── update-project-claude-v2.py # Project-level CLAUDE.md automation
113-
│ ├── update-claude-configs-v2.sh # Standalone script for both CLAUDE.md files
114-
│ └── devenv.nix # DevEnv automation environment
104+
├── 📁 overlays/ # Custom package overlays
105+
│ └── jules.nix # Google Jules integration
115106
├── 📁 docs/ # Organized documentation
116-
│ ├── automation/
117-
│ │ └── claude-automation-system.md
118-
│ ├── tools/
119-
│ │ ├── fish-smart-commands.md
107+
│ ├── architecture/ # System architecture documentation
108+
│ │ └── CLAUDE_ORCHESTRATION.md
109+
│ ├── automation/ # Automation system docs
110+
│ │ ├── claude-automation-system.md
111+
│ │ └── REFACTORING_PLAN_USER_POLICIES_MERGE.md
112+
│ ├── guides/ # User guides and how-tos
113+
│ │ └── COMMON_TASKS.md
114+
│ ├── integrations/ # External system integrations
115+
│ │ └── CURSOR_AI_QUALITY_INTEGRATION.md
116+
│ ├── planning/ # Future plans and proposals
117+
│ │ ├── active/ # Active planning documents
118+
│ │ │ └── HN_LAUNCH_PLAN.md
119+
│ │ └── archive/ # Completed plans
120+
│ ├── tools/ # Tool-specific guides
120121
│ │ ├── enhanced-tools-guide.md
122+
│ │ ├── fish-smart-commands.md
121123
│ │ ├── kitty-optimization-guide.md
122124
│ │ └── yazi-file-associations.md
123-
│ └── CURSOR_AI_QUALITY_INTEGRATION.md
125+
│ └── archive/ # Historical documentation
126+
│ ├── claude-automation-system-OLD.md
127+
│ └── DOCUMENTATION_AUDIT_2025-10-06.md
124128
├── 🔧 rebuild-nixos # Interactive rebuild script
125129
├── 📋 flake.nix # Flake configuration
126-
├── 📚 CLAUDE.md # Project-level AI agent instructions (auto-generated)
127-
└── 🤖 CLAUDE_ORCHESTRATION.md # Three-level Claude Code orchestration architecture
130+
└── 📚 CLAUDE.md # Project-level AI agent instructions (auto-generated)
128131
```
129132

130133
## 🚀 Setup Instructions
@@ -806,9 +809,13 @@ The system detects:
806809
### Core System Documentation
807810

808811
- **[CLAUDE.md](CLAUDE.md)** - Project-level AI agent instructions (auto-generated)
809-
- **[CLAUDE_ORCHESTRATION.md](CLAUDE_ORCHESTRATION.md)** - Three-level Claude Code orchestration architecture (System/Project/Template)
812+
- **[docs/architecture/CLAUDE_ORCHESTRATION.md](docs/architecture/CLAUDE_ORCHESTRATION.md)** - Three-level Claude Code orchestration architecture
810813
- **[templates/README.md](templates/README.md)** - Enterprise-grade development templates with Cursor AI integration
811814

815+
### User Guides
816+
817+
- **[docs/guides/COMMON_TASKS.md](docs/guides/COMMON_TASKS.md)** - Quick reference for frequent operations
818+
812819
### Major Systems
813820

814821
- **[basb-system/README.md](basb-system/README.md)** - Building a Second Brain knowledge management implementation
@@ -817,8 +824,9 @@ The system detects:
817824

818825
### AI Development Integration
819826

820-
- **[docs/CURSOR_AI_QUALITY_INTEGRATION.md](docs/CURSOR_AI_QUALITY_INTEGRATION.md)** - Cursor AI and quality gates integration guide
827+
- **[docs/integrations/CURSOR_AI_QUALITY_INTEGRATION.md](docs/integrations/CURSOR_AI_QUALITY_INTEGRATION.md)** - Cursor AI and quality gates integration
821828
- **[Claude NixOS Automation](https://github.com/jacopone/claude-nixos-automation)** - Claude Code auto-generation system (external flake)
829+
- **[docs/automation/claude-automation-system.md](docs/automation/claude-automation-system.md)** - Integration guide (deprecated, redirects to external repo)
822830

823831
### Tools & Configuration Guides
824832

File renamed without changes.
File renamed without changes.

docs/automation/claude-automation-system.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
### For High-Level Architecture
1414

15-
See **[CLAUDE_ORCHESTRATION.md](../../CLAUDE_ORCHESTRATION.md)** for:
15+
See **[docs/architecture/CLAUDE_ORCHESTRATION.md](../architecture/CLAUDE_ORCHESTRATION.md)** for:
1616
- Three-level Claude Code orchestration system (System/Project/Template)
1717
- How auto-generation integrates with `./rebuild-nixos`
1818
- Manual trigger commands
File renamed without changes.
File renamed without changes.

templates/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ gitleaks # Secret detection
245245

246246
- **Main README**: `~/ai-project-orchestration/README.md`
247247
- **Installation Guide**: `~/ai-project-orchestration/INSTALLATION_COMPLETE.md`
248-
- **Quality Integration**: `~/nixos-config/docs/CURSOR_AI_QUALITY_INTEGRATION.md`
248+
- **Quality Integration**: `~/nixos-config/docs/integrations/CURSOR_AI_QUALITY_INTEGRATION.md`
249249

250250
## 🎯 **Use Cases**
251251

0 commit comments

Comments
 (0)