Repository navigation
docs: improve OSS README - #4915
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThe pull request rewrites the main README and quickstart guide. It adds product positioning, local evaluation instructions, Bash and SDK examples, asynchronous usage polling, runtime guidance, and production deployment information. ChangesOpenMeter documentation refresh
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✨ 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 |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🧹 Nitpick comments (1)
README.md (1)
99-105: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winPin the versions used by the quickstart.
npm install@openmeter/sdktsx,pip install --pre openmeter, andlatestcontainer images resolve moving versions. Later releases can change the documented APIs or behavior. Pin versions tested with this README, or document a supported compatibility range.As per path instructions: “Assess the documentation for misspellings, grammatical errors, missing documentation and correctness.”
Also applies to: 149-155, 194-197
🤖 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` around lines 99 - 105, Pin the dependency versions used throughout the README quickstarts, including `@openmeter/sdk`, tsx, openmeter, and container image references at the noted sections. Use versions tested with the documented examples, or state a supported compatibility range, and keep all installation and execution commands consistent with those versions.Source: Path instructions
🤖 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.
Inline comments:
In `@quickstart/README.md`:
- Around line 47-50: Update the quickstart examples’ event identity fields so
each run uses a unique id and subject across all three payloads, preventing
deduplication on reruns; alternatively, clearly document the required cleanup
step before rerunning. Ensure the corresponding query examples remain correct
for the chosen behavior.
- Around line 41-59: Update the Bash example around the ingest curl and polling
loop to fail on unsuccessful results: capture and validate the ingest HTTP
status as 204, track whether the polling response matched `"value":1`, and exit
non-zero when ingestion fails or ten attempts complete without a match. Preserve
printing the final response only after maintaining these checks.
In `@README.md`:
- Around line 85-91: Update the README polling loop around the response
validation so it matches a JSON metric value exactly equal to 1, rather than
allowing values such as 10. Use a JSON-aware check or boundary-aware pattern
while preserving the existing retry and sleep behavior.
- Around line 73-91: The Bash example should fail on HTTP and command errors.
Add `set -euo pipefail` before the requests and include the `-f` option in the
initial POST `curl` command; preserve the existing polling and response output
behavior.
- Around line 39-42: Update the “How mature is it?” entry to use the precise
release-status wording “Releases are in beta,” and either add dated
authoritative citations supporting the metering engine’s production history and
billions of usage events or soften/remove those claims if suitable sources are
unavailable.
- Around line 56-64: Update the README prerequisites around the local evaluation
stack to state that Docker Compose 2.1.1 or later is required for the `--wait`
option used in `docker compose up -d --wait`; keep the existing command
unchanged.
---
Nitpick comments:
In `@README.md`:
- Around line 99-105: Pin the dependency versions used throughout the README
quickstarts, including `@openmeter/sdk`, tsx, openmeter, and container image
references at the noted sections. Use versions tested with the documented
examples, or state a supported compatibility range, and keep all installation
and execution commands consistent with those versions.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: cf9c6305-d5b7-4a60-a73f-479ae94d3880
⛔ Files ignored due to path filters (1)
assets/how-openmeter-works.svgis excluded by!**/*.svg
📒 Files selected for processing (2)
README.mdquickstart/README.md
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
55-57: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winList
npmas a TypeScript prerequisite.The TypeScript example runs
npm installandnpx tsx, but this list names only Node.js. Addnpmto matchquickstart/README.mdand avoid a missing-command failure.As per path instructions, “Assess the documentation for misspellings, grammatical errors, missing documentation and correctness.”
🤖 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` around lines 55 - 57, Update the prerequisites sentence in the README to explicitly list npm alongside Node.js for the TypeScript examples, matching the prerequisite documentation in quickstart/README.md while preserving the existing Git, Docker, curl, and Python requirements.Source: Path instructions
🤖 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.
Outside diff comments:
In `@README.md`:
- Around line 55-57: Update the prerequisites sentence in the README to
explicitly list npm alongside Node.js for the TypeScript examples, matching the
prerequisite documentation in quickstart/README.md while preserving the existing
Git, Docker, curl, and Python requirements.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 6d6f480a-e58b-4b02-9bf2-bf8d449e39e0
📒 Files selected for processing (2)
README.mdquickstart/README.md
4 participants
I've been thinking for a long while that our README is sub-par but wasn't really sure what should be included... I'm really liking this direction and I think its significantly better.
See preview here https://github.com/openmeterio/openmeter/tree/codex/improve-oss-readme
Summary by CodeRabbit
Greptile Summary
The PR substantially rewrites the OSS documentation to clarify OpenMeter’s capabilities, intended use, runtime guidance, and community resources.
Confidence Score: 5/5
The PR appears safe to merge.
No blocking failure remains.
Important Files Changed
Reviews (7): Last reviewed commit: "docs: clarify Helm chart scope" | Re-trigger Greptile