Sort modules by purpose in the reference
Open
Nobody has claimed this yet.
design
raw idea
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
In our https://www.tarantool.io/en/doc/latest/reference/, modules are sorted alphabetically, which is a bit messy. Consider the header "Module say (logging)", which is different from the others because it explains the purpose of the modules.
In Awesome Tarantool, modules are sorted by their purpose. Users make sense of this sort more easily.
Tentative plan:
- Add umbrella topics for modules in the reference
- Add links to missing module docs. Initially they can be links to GitHub wiki, external pages, etc.
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 latest reference page and compare its module ordering with the Awesome Tarantool list. Identify the modules that need umbrella topics and the missing documentation links, then verify that the reference is grouped by purpose and every listed module has a usable link.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100