Skip to content

Commit bc1a271

Browse files
authored
Merge pull request #10 from BruinGrowly/claude/update-readme-011CUf7NJcXsSSKr1fXAedS5
docs: Update README with comprehensive documentation index
2 parents 091121e + 1692091 commit bc1a271

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,12 @@ Analysis Complete.
9494
## Documentation
9595
9696
### Getting Started
97+
- **[Quick Reference](docs/QUICK_REFERENCE.md)** - One-page cheat sheet
98+
- Quick installation
99+
- Score interpretation table
100+
- Common semantic patterns
101+
- Fast integration examples
102+
97103
- **[User Guide](docs/USER_GUIDE.md)** - Comprehensive guide to using Python Code Harmonizer
98104
- Installation and setup
99105
- Understanding disharmony scores
@@ -111,6 +117,12 @@ Analysis Complete.
111117
- Interpretation guidance
112118
- Troubleshooting tips
113119
120+
- **[Troubleshooting](docs/TROUBLESHOOTING.md)** - Common issues and solutions
121+
- Installation problems
122+
- Import errors
123+
- Platform-specific issues
124+
- Integration debugging
125+
114126
### Advanced Topics
115127
- **[Philosophy](docs/PHILOSOPHY.md)** - Deep dive into the Anchor Point and ICE Framework
116128
- The four dimensions (Love, Justice, Power, Wisdom)
@@ -129,6 +141,45 @@ Analysis Complete.
129141
- Integration examples
130142
- Best practices
131143
144+
- **[Comparison Guide](docs/COMPARISON.md)** - How Harmonizer fits with other tools
145+
- vs Pylint, MyPy, Pytest, Black, Bandit, Radon
146+
- Unique value proposition
147+
- Recommended tool stacks
148+
- Complementary usage
149+
150+
### Examples & Integration
151+
- **[Real-World Bugs](examples/real_world_bugs.py)** - Semantic bugs other tools miss
152+
- 7 actual bugs Harmonizer catches
153+
- Validation functions that modify
154+
- Get functions that delete
155+
- Before/after fixes
156+
157+
- **[Refactoring Journey](examples/refactoring_journey.py)** - Before & after refactoring
158+
- 5 complete refactoring examples
159+
- Score improvements demonstrated
160+
- Common patterns identified
161+
- Best practices shown
162+
163+
- **[Severity Levels](examples/severity_levels.py)** - Functions at each score range
164+
- Excellent (0.0-0.3)
165+
- Low concern (0.3-0.5)
166+
- Medium concern (0.5-0.8)
167+
- High concern (0.8-1.0)
168+
- Critical (1.0+)
169+
170+
- **[Integration Templates](.)** - Ready-to-use configurations
171+
- [GitHub Actions workflow](.github/workflows/harmony-check.yml) - CI/CD integration
172+
- [Pre-commit hook template](.pre-commit-config.yaml.template) - Local development
173+
- [VS Code tasks](.vscode/tasks.json) - IDE integration
174+
- [Config template](.harmonizer.yml.template) - Future configuration support
175+
176+
### Project Documentation
177+
- **[Changelog](CHANGELOG.md)** - Version history and roadmap
178+
- Release notes
179+
- Feature additions
180+
- Future plans
181+
- Upgrade guides
182+
132183
---
133184
134185
## Development & Contribution

0 commit comments

Comments
 (0)