GDQuest / GDQuest/gdscript-docs-maker
Code a tool to update a JSON reference file
- Langage dominant
- Python
- Étoiles
- 297
- Forks
- 26
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
To make the docs maker as flexible as possible, we'd like to support having JSON keys or metadata on top of the one generated by the tool. That is to say, extra fields that may not be in the tool, like code examples, links to tutorials, references... extra information that would clutter the source code.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Piste de recherche
Commencez par lire le flux de génération de la documentation du repository et identifiez où la référence JSON est produite. Déterminez comment les champs supplémentaires, tels que les exemples de code, les liens vers les tutoriels et les références, doivent être fournis et conservés, puis définissez les critères d’acceptation pour mettre à jour la référence générée sans encombrer le code source.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation, tooling
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100