getodk / getodk/docs

show glossary definitions inline

Open
#384 2 comments 0 reactions 0 assignees View on GitHub
coding discussion javascript
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

Identify terms from the glossary with some kind of decoration (e.g. dotted underline). On hover/click/??? the definition appears.

I don't know if this is necessary, links to the glossary may be sufficient. I'm thinking about terms like "enumerator" or "instance" that we throw around but that may not be familiar to everyone.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing glossary and the Sphinx documentation structure. First decide whether inline definitions are needed instead of glossary links, then define the interaction and decoration; the work is done when the chosen behavior is implemented consistently and its documentation build succeeds.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.