☂️ Expand Cartridge documentation
Open
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Cartridge docs described with ldoc is hard to understand and poor for examples of usage
- https://github.com/tarantool/cartridge/issues/952
- https://github.com/tarantool/doc/issues/2619
- https://github.com/tarantool/doc/issues/2614
- https://github.com/tarantool/cartridge/issues/205
- https://github.com/tarantool/LDoc/issues/6
- And a lot of tasks to do...
What have been done:
Feel free to update this comment and add tasks.
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
Review the linked Cartridge, doc, and LDoc issues, along with pull requests 1576 and 1597, to identify which documentation tasks remain. The issue is a broad checklist rather than a single scoped change; completion would require resolving the remaining listed tasks and defining concrete examples and documentation improvements.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100