IntersectMBO / IntersectMBO/ouroboros-consensus
Change the notation in the Glossary from `; TERM` to `{ TERM }`
- Dominant language
- Haskell
- Stars
- 67
- Forks
- 43
- Avg merge
- 5d 13h
- Merged PRs (30d)
- 43
Description
Currently, the Consensus [Glossary](https://github.com/IntersectMBO/ouroboros-consensus/blob/main/docs/website/contents/for-developers/Glossary.md) uses the `; TERM` notation in every definition. This allows to search for `TERM` more easily with `CTRL-F` in a browser.
The Genesis docs (see the [PR](https://github.com/IntersectMBO/ouroboros-consensus/pull/1174), soon to be merged) use the `{ TERM }` notation, which seems like a better fit for longer term names.
If time permits, we should switch the glossary from the `;` notation to the new `{}` notation.
Contributor guide
Research direction
Open docs/website/contents/for-developers/Glossary.md and compare its definition notation with the `{ TERM }` style used by the Genesis documentation referenced in PR #1174. Replace the existing `; TERM` notation consistently and verify that every glossary definition uses the new form.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100