docs: refactor README for clarity and scannability#113
Open
marco-spagn wants to merge 2 commits into
Open
Conversation
- Flatter hierarchy with bold section headers for quick scanning - Quickstart stays prominent at the top - Features consolidated into readable prose grouped by area - Architecture diagram and API surface tables simplified - Development section organized by use case (essential, full stack, CI, feature smokes) - Repository layout reduced to essentials (full details in docs/CODEBASE.md) - Removed redundant target table (duplicated Makefile content) - Added Cognitive Graph and MCP to feature list - More whitespace, shorter paragraphs, linked docs for deep dives Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
✅ Test coverage:
|
| Package | Stmts | Covered | Coverage |
|---|---|---|---|
config |
64 | 56 | ✅ 87.5% |
crypto |
99 | 87 | ✅ 87.9% |
database |
16 | 15 | ✅ 93.8% |
embedding |
125 | 118 | ✅ 94.4% |
event |
273 | 206 | ✅ 75.5% |
eventschema |
23 | 21 | ✅ 91.3% |
grpc |
819 | 624 | ✅ 76.2% |
handler |
868 | 579 | ✅ 66.7% |
metrics |
27 | 18 | ✅ 66.7% |
middleware |
180 | 152 | ✅ 84.4% |
model |
95 | 66 | ✅ 69.5% |
ratelimit |
38 | 28 | ✅ 73.7% |
repository |
937 | 708 | ✅ 75.6% |
service |
335 | 260 | ✅ 77.6% |
telemetry |
26 | 24 | ✅ 92.3% |
webhook |
131 | 43 | 🟡 32.8% |
worker |
503 | 156 | ✅ 31.0% |
| Global | 4559 | 3161 | ✅ 69.3% |
Generated by scripts/ci_coverage_check.sh — bump floors in the same PR that lifts coverage.
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
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
Type of change
Checklist
make test(andmake lintfor Go changes)make ci-like-githubor targeted job parity (make act-lint,make act-test,make act-integration-smoke) for CI-touching changes-tags=integrationwhere relevant)[Unreleased]if user-visibleinternal/version/version.go+docs/openapi.yaml+ HelmappVersionif releasing API version (smoke picks upTagautomatically)docs/grpc-vs-http.md/ SDKHTTP-API.mdupdated for API changesTest plan