Docs/add glossary#79
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #79 +/- ##
=======================================
Coverage 98.82% 98.82%
=======================================
Files 5 5
Lines 255 255
=======================================
Hits 252 252
Misses 3 3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Hi @rajatkriplani, thanks for having a go! This looks good, but it would be great if we can implement the glossary as a sphinx directive. You can find more details here. It may take a while to understand and research how it works, but it seems worth it. Feel free to have a go in this PR if you are interested! |
|
@sfmig earlier I forgot to build the glossary page, it's done now. edit: Is rst format only for the glossary documentation, or should all the documents follow this format? Let me know so that I know whether to change the VIA labelling document as well. |
Description
What is this PR
Why is this PR needed?
It adds the glossary to computer vision concepts that may be useful for researchers.
What does this PR do?
Adds a glossary page in simple markdown format taking reference from
movementReferences
Closes #25 for now, more terms can be added later.
How has this PR been tested?
The new "Glossary" was built locally and it worked fine.
Is this a breaking change?
No, It's adds new docs page.
Does this PR require an update to the documentation?
Yes. This PR is a documentation update — glossary is a new addition to the documentation set.
Checklist: