docs: move definition of terms to glossary and update definitions - Githubissues

seedcase-project / design

Overall architectural design documentation for Seedcase software.

https://design.seedcase-project.org

Creative Commons Attribution 4.0 International

0 stars 0 forks source link

docs: move definition of terms to glossary and update definitions #101

Closed signekb closed 3 months ago

signekb commented 3 months ago

Description

This PR adds a glossary by moving the "Definition of terms" section from the introduction and updating/adding definitions of relevant terms.
These changes are done so we 1) are clear on what is meant when we use specific terms and 2) can link to these definitions throughout the documentation.

Related Issues

Closes #28

Reviewer Focus

This PR only needs a quick review.

Please check the definitions and suggest changes to them if they aren't correct
Are we missing some definitions?
Does it make sense to include two sections in the glossary like I have done here? One for Seedcase specific terms and one for more general ones?

Checklist

For general documentation:

[X] Spell-check
[X] Did the page(s) preview correctly on your machine without breaking
[ ] New category words (keywords) (if any) added to the code snippet file