Skip to content

Commit 53da517

Browse files
aledlieclaude
andcommitted
docs: Phase 4 - Update documentation to reflect new structure
Updated CLAUDE.md: - Updated example commands with new output paths - Documented new docs/ subdirectory organization - Updated Directory Structure section with outputs/ and docs/ details - Updated Output Files section with organized paths by type - Added comprehensive directory tree with all subdirectories Changes reflect: - outputs/ organized by report type (schemas, quality, coverage, dependencies, dashboards, rss) - docs/ organized by purpose (guides, summaries, testing, integrations, refactoring, examples, archive) - All generated files gitignored - Timestamp-based naming for all outputs 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 7985b47 commit 53da517

1 file changed

Lines changed: 51 additions & 16 deletions

File tree

‎CLAUDE.md‎

Lines changed: 51 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -201,11 +201,11 @@ python3 -m src.analyzers.dependencies /path/to/code \
201201
**Interactive Dashboard**:
202202
```bash
203203
python3 -m src.generators.dashboard \
204-
--schemas schemas_enhanced.json \
205-
--quality quality_report.json \
206-
--coverage coverage_report.json \
207-
--dependency dependency_report.json \
208-
--output dashboard.html
204+
--schemas outputs/schemas/schemas_enhanced.json \
205+
--quality outputs/quality/quality_report.json \
206+
--coverage outputs/coverage/coverage_report.json \
207+
--dependency outputs/dependencies/dependency_report.json \
208+
--output outputs/dashboards/dashboard.html
209209
```
210210

211211
### Testing
@@ -307,8 +307,15 @@ python -m src.analyzers.dependencies src/ --clear-cache
307307
- `src/utils/performance_monitor.py` - Performance monitoring and reporting
308308

309309
**Documentation**:
310-
- `docs/PERFORMANCE_TUNING.md` - Comprehensive performance tuning guide
311-
- `docs/CI_CD_INTEGRATION.md` - CI/CD integration with optimizations
310+
- `docs/guides/PERFORMANCE_TUNING.md` - Comprehensive performance tuning guide
311+
- `docs/guides/CI_CD_INTEGRATION.md` - CI/CD integration with optimizations
312+
- `docs/guides/` - How-to guides and implementation documentation
313+
- `docs/summaries/` - Project phase summaries and completion reports
314+
- `docs/testing/` - Test documentation and test case specifications
315+
- `docs/integrations/` - Integration guides (Sentry, Doppler, etc.)
316+
- `docs/refactoring/` - Refactoring plans and analysis
317+
- `docs/examples/` - Code examples and usage patterns
318+
- `docs/archive/` - Historical documentation
312319

313320
## Critical Implementation Details
314321

@@ -400,10 +407,27 @@ scripts/ # Executable orchestration scripts
400407
tests/
401408
├── unit/ # Isolated unit tests for each module
402409
├── integration/ # End-to-end pipeline tests
410+
├── performance/ # Performance benchmarking tests
403411
└── fixtures/ # Sample code for testing
404412
413+
outputs/ # All generated outputs (gitignored)
414+
├── schemas/ # Generated schema files
415+
├── quality/ # Code quality reports
416+
├── coverage/ # Test coverage reports
417+
├── dependencies/ # Dependency analysis reports
418+
├── dashboards/ # Interactive HTML dashboards
419+
└── rss/ # RSS feed files
420+
421+
docs/ # Organized documentation
422+
├── guides/ # How-to guides and implementations
423+
├── summaries/ # Project phase summaries
424+
├── testing/ # Test documentation
425+
├── integrations/ # Integration guides (Sentry, Doppler)
426+
├── refactoring/ # Refactoring plans
427+
├── examples/ # Code examples
428+
└── archive/ # Historical documentation
429+
405430
ast-grep-rules/ # Custom ast-grep pattern definitions
406-
docs/ # Documentation (guides, summaries, test cases)
407431
```
408432

409433
### Skipped Directories
@@ -490,13 +514,24 @@ Most test failures are due to file path issues. Tests expect to run from reposit
490514

491515
## Output Files
492516

493-
All analysis tools generate both JSON (machine-readable) and TXT (human-readable) reports:
517+
All analysis tools generate both JSON (machine-readable) and TXT (human-readable) reports organized by type:
518+
519+
**Schema Files** (`outputs/schemas/`):
520+
- `schemas_enhanced.json`: Complete code structure with schema.org vocabulary
521+
522+
**Quality Reports** (`outputs/quality/`):
523+
- `quality_report_YYYYMMDD_HHMMSS.json/txt`: Code quality issues by severity and category
524+
525+
**Coverage Reports** (`outputs/coverage/`):
526+
- `coverage_report_YYYYMMDD_HHMMSS.json/txt`: Test coverage analysis with untested functions
527+
528+
**Dependency Reports** (`outputs/dependencies/`):
529+
- `dependency_report_YYYYMMDD_HHMMSS.json/txt`: Dependency graph with circular dependencies
530+
531+
**Dashboards** (`outputs/dashboards/`):
532+
- `dashboard_YYYYMMDD_HHMMSS.html`: Interactive visualization of all metrics
494533

495-
- `schemas_enhanced.json`: Complete code structure with 36MB+ of data
496-
- `quality_report_*.json/txt`: Code quality issues by severity and category
497-
- `coverage_report_*.json/txt`: Test coverage analysis with untested functions
498-
- `dependency_report_*.json/txt`: Dependency graph with circular dependencies
499-
- `dashboard_*.html`: Interactive visualization of all metrics
500-
- `code_updates_*.xml`: RSS feed with git commit history
534+
**RSS Feeds** (`outputs/rss/`):
535+
- `code_updates_YYYYMMDD_HHMMSS.xml`: RSS feed with git commit history
501536

502-
Generated files are timestamped to avoid overwriting previous runs.
537+
All generated files are timestamped and automatically gitignored to prevent committing generated content.

0 commit comments

Comments
 (0)