Proofread and update `membership` module page
Open
Nobody has claimed this yet.
add details
reference
rewrite
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_rock/membership/
SME: @ yngvar-antonsson
Details
Module README: https://github.com/tarantool/membership#readme
API: https://github.com/tarantool/membership/blob/7a8781640e54b75d849753a7ec23806575a7ebdc/membership.lua
Definition of done
- Update overview sections according to README file
- Check and update API description
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 root membership module page and compare its overview with the linked membership README. Then inspect the pinned membership.lua API source and update the page's API description. Done means the overview matches the README and the API documentation has been checked and updated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100