GDQuest / GDQuest/gdscript-docs-maker

Code a tool to update a JSON reference file

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

説明

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.

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

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

調査の方向性

まず、repository のドキュメント生成フローを読み、JSON リファレンスがどこで生成されるかを特定します。コード例、チュートリアルへのリンク、リファレンスなどの追加フィールドをどのように提供し、保持すべきかを確認し、そのうえでソースコードを煩雑にせずに生成済みリファレンスを更新するための受け入れ基準を定義します。

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

評価

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

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

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