GDQuest / GDQuest/gdscript-docs-maker

Detect new, changed, or removed features

オープン
#37 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
enhancement
主要言語
Python
スター
297
フォーク
26
PR マージ指標
30日以内にマージされた PR はありません

説明

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.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

#36から始め、次にmerge_json.pyを読み、project.godotを調べて、利用可能なバージョンデータとドキュメントのマージフローを理解します。バージョン比較とオブジェクトごとのメタデータで、新しい機能、変更された機能、削除された機能をどのように表現するかを定義します。設定可能なラベルとCSSクラスも含めます。生成されたMarkdownにプロジェクトのバージョンが含まれ、変更されたエントリが正しくマークされれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
godot, python
領域
documentation, tooling
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。