Add a glossary to the documentation
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 11.5k
- Forks
- 904
- Avg merge
- 4d 17h
- Merged PRs (30d)
- 18
Description
Call it glossary.rst - it can use a definition list something like this:
.. _glossary:
Glossary
========
Term
A definition of the term.
Another term
Another definition.
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
Create the requested glossary.rst using the definition-list structure shown in the issue. First inspect the existing documentation layout to determine where the file belongs and which project terms need definitions; done means the glossary exists in the documentation and renders with the requested format.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100