firebase / firebase/firebase-admin-java

FR: Source maps for docs

Offen
#41 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
type: feature request
Vorherrschende Sprache
Java
Sterne
620
Forks
305
Ø Merge
3 Std. 23 Min.
Gemergte PRs (30 T.)
1

Beschreibung

Add a source map to the doc generation process so that reference docs can link directly into source files for each function/constant/etc.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, den Prozess zur Dokumentationsgenerierung im Repository zu lokalisieren, und untersuche, wie Referenzdokumentation für Funktionen und Konstanten erzeugt wird. Ermittle, wo eine Source Map ausgegeben würde und wie generierte Links auf Stellen in Quelldateien verweisen sollten. Als erledigt gilt die Aufgabe, wenn die Referenzdokumentation direkt auf die entsprechenden Quellcode-Stellen verlinkt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java
Bereich
build-system, documentation
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.