Improve README structure: add missing Installation, Usage, Development section(s) [Generated by gurnben's Agent]#246
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: gurnben The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, 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 have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ✨ 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. Review rate limit: 0/1 reviews remaining, refill in 55 minutes and 53 seconds.Comment |
gurnben
changed the title
| ./ocm-metamodel-tool generate --model=/path/to/ocm-api-model/model --output=/path/to/output | ||
| ``` | ||
|
|
||
| Run `./ocm-metamodel-tool --help` for all available commands and options. |
There was a problem hiding this comment.
Is this accurate? 🤔 I dont believe it is..
This tool isn't ment to be used alone but coupled with the SDK and model projects.
There was a problem hiding this comment.
Good catch -- you're right that ocm-metamodel-tool is primarily used as part of the SDK/model generation pipeline rather than invoked standalone. I can update this Usage section to reflect that context, something like:
## Usage
This tool is used as part of the OCM SDK and API model code generation pipeline.
It processes model definitions from [ocm-api-model](https://github.com/openshift-online/ocm-api-model)
and generates Go source code for [ocm-sdk-go](https://github.com/openshift-online/ocm-sdk-go).
See the ocm-api-model and ocm-sdk-go repositories for the full generation workflow.
Would that be more accurate? Happy to adjust to whatever best describes the intended usage.
Replaces the inaccurate standalone CLI usage example with a description of how the tool fits into the OCM SDK/model code generation pipeline, as discussed with @nimrodshn. Also fixes the binary name comment and expands test targets to match the actual Makefile.
2 participants
Summary
Adds missing README sections to improve documentation structure.
Changes
AgentReady Score Impact
This PR is part of an organization-wide initiative to improve AI-assisted development readiness across
openshift-online, measured by AgentReady (v2.31.2).Attributes addressed by this PR
Context
AgentReady checks for three essential README sections: Installation, Usage, and Development. This PR adds only the sections that were missing — existing content is preserved unchanged.
Testing