Skip to content

docs: address claude-review issues #10–#14 - #15

Open
sfloess wants to merge 5 commits into
mainfrom
docs/claude-review-issues-10-14
Open

docs: address claude-review issues #10–#14#15
sfloess wants to merge 5 commits into
mainfrom
docs/claude-review-issues-10-14

Conversation

@sfloess

@sfloess sfloess commented Aug 31, 2026

Copy link
Copy Markdown
Member

Summary

Addresses the five open [claude-review] issues filed 2026-08-31.

Issue Change
#10 Publish test coverage metrics README Testing section: 172 test_* functions; coverage % deferred to CI pre-v0.2.0
#11 Pin git dependencies docs/VERSIONING.md — dogfood HEAD policy + v0.2.0+ tag/SHA pin plan (actual pins blocked until sibling libs are tagged)
#12 Code usage examples README Usage examples: CLI, capability API, and CodingAgent loop
#13 security.md Existing docs/SECURITY.md already meets depth; README now links it from Credentials/Safety
#14 Troubleshooting docs/TROUBLESHOOTING.md + known-limitations table in README

Test plan

- Expand README with usage examples, testing metrics, troubleshooting links
- Add docs/TROUBLESHOOTING.md for dogfood failure recovery
- Add docs/VERSIONING.md for HEAD vs tag pin policy (v0.2.0+)
- Surface existing docs/SECURITY.md from README credentials/safety sections

Closes #10, #12, #13, #14
Tracks #11 (document strategy; pins deferred until library tags exist)
@sonarqubecloud

sonarqubecloud Bot commented Sep 1, 2026

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[claude-review] Publish test coverage metrics in README

1 participant