As a contributor, I come across a term or acronym I don’t understand and want to quickly discover the meaning of it.
I access the Documentation/Glossary page of the Arrow website and type my query into a search bar.
A table on the page is filtered to a small set of results. The columns of the table are “Term”, “Description”, and “Links”.
Other Requirements:
Glossaries also get included in release documentation. There should be a way to make a Glossary Release
Desirements:
Should support Markdown (emojis, bold, italic, etc.)
Option 1 (Quick and Dirty):
Store these definitions in a YAML or JSON file in the GitHub repository
All updates to terms can be done through PR
May not scale if the file becomes enormous
Not ideal for sorting and filtering
https://datatables.net/
Option 2 (Potentially More Scalable):
Store these definitions in a database (PostgreSQL?) on some server
Offload memory intensive operations (filtering, sorting of terms) to the server
Updates to terms are done by individuals with access to the database
Potentially a Discord command /define Arrow “Arrow is a decentralized community building open source vertical-takeoff aircraft and a rideshare protocol that will bring point to point air travel to everyone.” https://www.arrowair.com/
/define Arrow “Arrow is a decentralized community building open source vertical-takeoff aircraft and a rideshare protocol that will bring point to point air travel to everyone.” https://www.arrowair.com/