wpilibsuite/wpilib-docs

Glossary Usage Check

Open

#1,883 opened on Aug 21, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (297 forks)auto 404
ExtensionHelp Wanted

Repository metrics

Stars
 (187 stars)
PR merge metrics
 (PR metrics pending)

Description

Create/Find some plugin to scan each source page, and ensure that if a string is in any glossary, the first usage of that string in the .rst file is linked to the glossary. Error out if not

Tentatively, and maybe a bit more advanced.... rather than throwing an error, just automatically treat the first instance of each glossary term as a :term: rather than requiring the author to put it in.

Contributor guide

Research direction
Investigate how to create a Sphinx extension that scans .rst files for glossary terms and automatically links the first occurrence. Look at existing Sphinx glossary plugins and the Sphinx documentation on writing extensions.
Tech stack
python
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60