docs(readme): reflect the implemented state + add status badges - #181
Conversation
The README was untouched since the 2026-04-24 scaffolding and still claimed no code exists. ~180 PRs have landed since: the full ingest path (OTLP receiver -> WAL -> miner -> Parquet), the query path (pipe DSL -> DataFusion), and the first benchmark readings. - add a four-badge row (CI, license, Rust/MSRV, mdBook docs) - replace the draft banner with an honest pre-release status block - fix the architecture diagram: WAL is fsync'd before the miner runs (WAL-before-ack), not after; Parquet store is local-FS today - replace the speculative template:<id> / templates_drift() syntax with the shipped DSL (template_id ==, resolves_to(), drift from..to) - add a What-is-implemented section keyed to the RFCs and a benchmarks section citing docs/benchmarks.md section 9 as the live scoreboard (indicative ci-runner numbers, A1 miss stated honestly) - update repo layout (10 crates, semconv/ + templates/, no deploy/ yet), drop dead doc links (GOVERNANCE.md, docs/architecture/* that never landed), point Documentation at files that exist Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
@coderabbitai review |
|
Warning Review limit reached
More reviews will be available in 28 minutes and 16 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more credits in the billing tab to continue. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. 📝 WalkthroughWalkthroughThis pull request adds coverage badge publishing to a dedicated ChangesProject Visibility and Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
✅ Action performedReview finished.
|
There was a problem hiding this comment.
Pull request overview
Updates the repository’s top-level README to reflect the current implemented state of Ourios (rather than the original scaffold-era draft), including status, architecture, shipped DSL features, and pointers into the mdBook/RFC documentation set.
Changes:
- Add status badges (CI, license, Rust/MSRV, mdBook docs).
- Rewrite the status/feature/architecture sections to match the implemented ingest + query pipelines and current DSL surface.
- Refresh repo layout + documentation links to match the current tree.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…rkflow Coverage job publishes a shields endpoint JSON to the badges branch on main pushes (no external service); scorecard runs weekly + on main and feeds the API badge + code scanning. Best Practices left as a maintainer-enrollment placeholder. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Extended per maintainer request: ecosystem-style live badges — self-hosted coverage endpoint (published by the coverage job to a |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
66-66: 💤 Low valueConsider rephrasing to avoid repetition of "exactly."
The word "exactly" appears twice in close proximity (lines 66 and 67 in the original context). This can be softened for better flow. For example, "This is what Parquet + DataFusion is already optimized for when the file layout is right."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` at line 66, The sentence containing the phrase "This is exactly what Parquet + DataFusion is" repeats "exactly" and should be rephrased for better flow; replace that sentence (the one beginning "This is exactly what Parquet + DataFusion is") with a softer wording such as "This is what Parquet + DataFusion is already optimized for when the file layout is right." to remove the repetition and improve readability.Source: Linters/SAST tools
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@README.md`:
- Line 66: The sentence containing the phrase "This is exactly what Parquet +
DataFusion is" repeats "exactly" and should be rephrased for better flow;
replace that sentence (the one beginning "This is exactly what Parquet +
DataFusion is") with a softer wording such as "This is what Parquet + DataFusion
is already optimized for when the file layout is right." to remove the
repetition and improve readability.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: e6bde42f-48fc-4282-960a-086d06b492f0
📒 Files selected for processing (3)
.github/workflows/ci.yml.github/workflows/scorecard.ymlREADME.md
…ays the contract Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Why
The README predates all code: it is untouched since the 2026-04-24 scaffolding and still opens with "Status: draft. No code exists yet", lists
crates/as "empty for now", advertises a speculativetemplate:<id>/templates_drift(<service>)syntax and a "(LogQL-ish)" parser, and closes with "not, yet, a working backend". ~180 PRs have landed since. Maintainer-requested 2026-06-12.What changed
ci.ymlworkflow badge), Apache-2.0 license, Rust stable / MSRV 1.85 (fromrust-toolchain.toml+ workspacerust-version), and an mdBook docs badge linking to the in-repodocs/SUMMARY.md(GitHub Pages is not enabled yet, so no Pages URL).docs/benchmarks.md; no packaged release.miner → WAL → Arrow batches. The real pipeline (ourios-ingester::receiver::pipeline, §3.4 WAL-before-ack) isWAL (fsync, then ack) → miner → Parquet writer. The store is labelled local-FS today with object storage as the RFC 0005 design target, and the querier parser is "own grammar", not "LogQL-ish".template_id == 42,resolves_to(42), anddrift from -7d to now(RFC 0010), instead of the never-builttemplate:<id>/templates_drift().docs/benchmarks.md§9 as the live scoreboard, with the indicativeci-runnercaveat stated up front: B1 30–40× vszstdcat | grepwith exact counts, B2 flat ~3–4 ms, C1 1.000000, and the A1 miss (~0.82× vs zstd-19 against a ≥ 3.0× gate) reported as a miss. Hardware is identified only by theci-runner/baseline-8vcpu-32gibtags. Phrased to survive the in-progress authoritative baseline rerun.ourios-semconv,ourios-telemetry),semconv/+templates/weaver dirs, nodeploy/yet (Helm moved to "eventually" in Non-goals).docs/architecture/*files and aGOVERNANCE.mdthat were never created.Invariants / hazards
Docs-only; no code paths touched. The diagram fix restores the §3.4 WAL-before-ack invariant in the project's front-door description (the old diagram showed the miner running before the WAL).
Verification
crates/ourios-ingester/src/receiver/pipeline.rs; DSL syntax verified against RFC 0002/0010; benchmark numbers transcribed fromdocs/benchmarks.md§9.1–9.3.docs/SUMMARY.mddoes not include it), so nomdbook buildimpact.status: specified(the alias-amendment ladder re-entry; the alias scenarios have since landed in test(core): add the RFC 0001 alias write-path red gate (RFC0001.12-.16) #152/feat(core): operator-driven alias map + audited alias events (RFC0001.12-.16) #153 but the status flip hasn't), so the README describes the miner's implemented capabilities without asserting the RFC isgreen.🤖 Generated with Claude Code
Summary by CodeRabbit
Release Notes
Documentation
Chores