docs: overhaul project documentation for open-source readiness#36
Merged
Conversation
- Refine README.md: add badges, tech stack table, cleaner structure, link to new docs - Fix coverage threshold inconsistency (90% not 70%) in AGENTS.md and CLAUDE.md - Update AGENTS.md project structure to reflect server routes, ai_naming, annotations, and frontend - Create docs/ARCHITECTURE.md: system design, data flow diagrams, component breakdown, design decisions - Create docs/USAGE.md: all three modes, env var reference, full API endpoint listing - Create CONTRIBUTING.md: setup, testing, code style, PR process - Create CODE_OF_CONDUCT.md: Contributor Covenant v2.1 reference - Create SECURITY.md: vulnerability reporting, scope, considerations - Create CLAUDE.md: Claude Code guidance for this repository Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Tests Report 📄Tests Succees ✅JUnit Details
Coverage Details ☑️No coverage details to present |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
docs/ARCHITECTURE.md— system design, data flow diagrams, component breakdown, design decisionsdocs/USAGE.md— all three modes, full env var reference, complete API endpoint listingCONTRIBUTING.md— dev setup, testing, code style, commit conventions, PR processCODE_OF_CONDUCT.md— Contributor Covenant v2.1SECURITY.md— vulnerability reporting, scope, security considerationsCLAUDE.md— Claude Code guidance for this repositoryTest plan
🤖 Generated with Claude Code