firebase / firebase/firebase-admin-java

FR: Source maps for docs

Aperta
#41 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
type: feature request
Lingua principale
Java
Stelle
620
Fork
305
Merge medio
3h 23m
PR unite (30g)
1

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia individuando il processo di generazione della documentazione nel repository ed esamina come viene prodotta la documentazione di riferimento per funzioni e costanti. Determina dove verrebbe emessa una source map e come i link generati dovrebbero puntare alle posizioni corrispondenti nei file sorgente. Il lavoro è completato quando la documentazione di riferimento contiene link diretti alle posizioni corrispondenti nel codice sorgente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java
Ambito
build-system, documentation
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.