steps to get to generating glossary automatically
Open
Nobody has claimed this yet.
- Dominant language
- reStructuredText
- Stars
- 497
- Forks
- 41
- Avg merge
- 3h 52m
- Merged PRs (30d)
- 4
Description
- #681
note: this could come later, but I wanted to see if it could easily be done (then went ahead and doned it) - https://github.com/rust-lang/fls/pull/689
- Ensure main text defines all glossary terms
- Ensure the duplicate definitions that are in both glossary and main text have matching text
- If text does not match, choose one that is more accurate
- Ensure
:dt:entries are in main text and that there are none in glossary- This will mean clicking on the term in a glossary will take one to the main text
- Remove the "See SomeTerm" paragraphs in the glossary, because above step makes them redundant
- Generate the glossary from reading all
:dt:entries from main text, and ensure it matches the old glossary
Originally posted by @tshepang in https://github.com/rust-lang/fls/issues/656#issuecomment-3876000720
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 issue #681 and pull request #689 first, then compare the glossary with the main text. Work through the remaining checklist: align definitions, move :dt: entries into the main text, remove redundant “See SomeTerm” paragraphs, and generate a glossary that matches the existing one.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100