wpilibsuite/wpilib-docs

Glossary Usage Check

Offen

#1.883 geöffnet am 21.08.2022

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (297 Forks)auto 404
ExtensionHelp Wanted

Repository-Metriken

Stars
 (187 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Untersuche, wie eine Sphinx Erweiterung erstellt wird, die .rst Dateien nach Glossarbegriffen durchsucht und das erste Vorkommen automatisch verlinkt. Sieh dir vorhandene Sphinx Glossar Plugins und die Sphinx Dokumentation zum Schreiben von Erweiterungen an.
Tech Stack
python
Domain
documentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
GitPython
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60