docs: Comprehensive documentation for v0.7.0 and v0.8.0 features #39
Conversation
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
Added detailed documentation for the new impact classification (v0.7.0) and whitespace handling (v0.8.0) features: - Created docs/impact-classification.md (~3,450 words) - Four impact levels with detailed examples - Classification algorithm and decision matrix - CLI options and smart defaults - Caveat warning system - JSON Schema v2 documentation - Real-world use cases and examples - Created docs/whitespace-handling.md (~2,670 words) - Four whitespace modes with detailed behavior - Five whitespace issue types with detection - Language classification (11 significant, 14 insignificant) - Mode selection guide and best practices - Output format coverage for all modes - Updated docs/output-formats.md (~1,150 words added) - Split JSON schema into v1 (legacy) and v2 (current) - Added impact classification across all formats - Added whitespace warnings documentation - New jq examples for v2 schema - Updated README.md with concise overview - Added "Why Roslyn over tree-sitter?" section - Highlighted v0.7.0 and v0.8.0 features prominently - Added screenshot placeholders with links to samples - Documented new CLI options (--impact-level, --whitespace-mode) - Updated JSON example to show schema v2 - Added Synaptic Canvas integration section - Reorganized documentation links by category - Created samples/impact-demo/ with realistic examples - old.cs and new.cs demonstrating all impact levels - Generated output.json, output.html, output-filtered.json - samples/README.md with regeneration instructions - Created screenshot infrastructure - docs/screenshot-requirements.md with specifications - docs/images/ directory with README - Placeholder .TODO files with detailed capture instructions - Regenerated existing samples with v0.8.0 - Updated output-example.json and output-example.html - Now include impact classification and v2 schema Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
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 adds comprehensive documentation for the new impact classification (v0.7.0) and whitespace handling (v0.8.0) features completed over the weekend.
Documentation Added
New Documentation Files
docs/impact-classification.md (~3,450 words)
docs/whitespace-handling.md (~2,670 words)
docs/screenshot-requirements.md (10KB)
Updated Documentation
README.md
docs/output-formats.md (~1,150 words added)
Sample Files
samples/impact-demo/
samples/README.md
Updated existing samples
Screenshot Infrastructure
Key Features Documented
Impact Classification (v0.7.0)
Whitespace Handling (v0.8.0)
Impact
Testing
🤖 Generated with Claude Code