firebase / firebase/firebase-admin-java

FR: Source maps for docs

Ouverte
#41 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
type: feature request
Langage dominant
Java
Étoiles
620
Forks
305
Merge moyen
3 h 23 min
PR mergées (30 j)
1

Description

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

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par localiser le processus de génération de la documentation dans le dépôt et examinez comment la documentation de référence est produite pour les fonctions et les constantes. Déterminez où une source map serait émise et comment les liens générés devraient pointer vers les emplacements correspondants dans les fichiers source. Le travail est terminé lorsque la documentation de référence contient des liens directs vers les emplacements correspondants dans le code source.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
java
Domaine
build-system, documentation
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.