ManageIQ / ManageIQ/manageiq-api-client
document usage
Open
Nobody has claimed this yet.
enhancement
help wanted
- Dominant language
- Ruby
- Stars
- 11
- Forks
- 24
- PR merge metrics
- No merged PRs in 30d
Description
once the dust settles and we have a good percentage of the API working, the main README should be updated and possibly another file with more examples.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the main README and inspect the current API coverage to determine which usage examples are accurate. Identify whether a second examples file is needed, then update the documentation once a substantial portion of the API is working; done means the README and any added examples clearly document current usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100