meilisearch / meilisearch/meilisearch-ruby
`yardoc` documentation
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 224
- Forks
- 54
- PR merge metrics
- No merged PRs in 30d
Description
This gem doesn't really have great documentation. While there was discussion about the wiki in #541 I think rdoc documentation in the source code would be a better solution.
- would work offline
- could be picked up by code editors
- would be easier to keep up to date (if a pr makes a change it should change the documentation as well)
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 by reviewing the repository's existing documentation and public Ruby source to determine the scope of the missing YARD/RDoc coverage. The issue does not name files, entry points, or tests, so first define which API documentation is required and how completion will be checked.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100