-
Notifications
You must be signed in to change notification settings - Fork 409
glossary: add <abbr> tags everywhere! #461
Copy link
Copy link
Closed
Labels
A: docsArea: user documentation (gatsby-theme-iterative)Area: user documentation (gatsby-theme-iterative)good first issueGood for newcomersGood for newcomersp2-nice-to-haveLess of a priority at the moment. We don't usually deal with this immediately.Less of a priority at the moment. We don't usually deal with this immediately.type: enhancementSomething is not clear, small updates, improvement suggestionsSomething is not clear, small updates, improvement suggestions
Metadata
Metadata
Assignees
Labels
A: docsArea: user documentation (gatsby-theme-iterative)Area: user documentation (gatsby-theme-iterative)good first issueGood for newcomersGood for newcomersp2-nice-to-haveLess of a priority at the moment. We don't usually deal with this immediately.Less of a priority at the moment. We don't usually deal with this immediately.type: enhancementSomething is not clear, small updates, improvement suggestionsSomething is not clear, small updates, improvement suggestions
Once #431 is merged,There will be an initial glossary.js file with a set of terms we want to add
<abbr>tags around in the md files so they display glossary tooltips on hover and dotted underline links to click on (for mobile).Implement mobile view
per WIP: add glossary with some basic DVC terms #431 (review)@algomaster99Add missing glossary terms listed on create glossary #424.
We have to use discretion to chose at least one occurrence of each term in all the docs to have this functionality. Note that some of these occurrences are currently linked to some other doc and would need to be unlinked (but an equivalent link should be in the glossary tooltip).
Note that the "workspace" and "DVC project" terms are already fully applied as well as "cache directory" and "the project" (but maybe not simply "cache", so start from there).
There should be a section or a few sections called Basic Concepts in the user guide that is/are properly written on a user-level language explaining some missing concepts. The glossary tooltips could point to these sections among other things. An example would a DVC-file term and this link: https://dvc.org/doc/user-guide/dvc-file-formatExtracted to guide: new DVC Concepts section #550Review the terms and their descriptions in the glossary.js file, vs. all the existing definitions in md docs, possibly making the ones in docs shorter now that we can have the glossary tooltip over those occurrences of each term.
Possibly also add functionality to the glossary engine module so all theabbrterms in each doc are displayed on the right side bar (when visible, for wider screens) beneath the edit and chat buttons.