GDQuest / GDQuest/gdscript-docs-maker

Detect new, changed, or removed features

Ouverte
#37 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
enhancement
Langage dominant
Python
Étoiles
297
Forks
26
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

This feature should probably be part of the docs merge tool.

It'd be nice to have some metadata to:

- Display the version of the project in the generated markdown. We can get that from `project.godot`. See #36, it needs to be done first
- Detect new, modified, or removed features in a given update. That would happen comparing the version numbers and/or changes upon merging the data.
- We can then add a metadata field to each relevant json object to add a [configurable] new html tag and css class name to the entries in the generated markdown

See `merge_json.py` to write that code.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Commencez par #36, puis lisez merge_json.py et examinez project.godot afin de comprendre les données de version disponibles et le flux de fusion de la documentation. Définissez comment les comparaisons de versions et les métadonnées par objet doivent représenter les fonctionnalités nouvelles, modifiées et supprimées, notamment le label configurable et la classe CSS. C’est terminé lorsque le Markdown généré inclut la version du projet et marque correctement les entrées modifiées.

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

Évaluation

Stack technique
godot, python
Domaine
documentation, tooling
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

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