[chore] Restructure developer docs
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 20/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
調査の方向性
まず、バージョン管理されたドキュメント構成を確認します。特に Developer Guides、Core APIs、Plugin Types、Subsystems を重点的に確認してください。Output などの API（format_string と format_text を含む）が現在どこにドキュメント化されているかを比較し、どのように再編成すべきかを特定します。静的な関数シグネチャではなく、より明確なガイドと最新のドキュメントへのリンクを備えた構成について合意できれば完了です。
索引モデルが issue の本文から書いたものです。
説明
What do we need to do?
When we started the devdocs we tried to consider to structure our existing content better.
We have, largely speaking, achieved that. However, the current structure is still somewhat confusing.
flowchart TD
C[Versioned documentation]
C --> GUIDES[Developer Guides]
C --> API[API Guides]
API --> FILES[Common files]
API --> CORE[Core APIs]
API --> PLUGIN[Plugin Types]
API --> SUBSYSTEM[Subsystems]
C --> DEVUP[Developer Updates]
Within each of API guide sections we have a fairly large list of APIs and information, and it isn't always clear which location docs should be in. For example, the Output API documentation which covers critical methods such as {{format_string}}, and {{format_text}} are under Subsystems, but arguably these shoudl be uder "Core APIs". For most people APIs such as these subsystem APIs are so critical to the daily development of Moodle that their categorisation as a subsystem is confusing when compared to a subsystem such as Task, Editor, Privacy, Check, Availability, etc.
I think we need to find a way to reduce these restructure some of these categories, and perhaps toimprove our "Developer guides" too.
Many of the se Core API and Subsystem docs would be better served as guides. It is not in our interest to store API documentation in any static form with function signatures in these docs. We should find better ways to link to the live documentation instead.
- 主要言語
- TypeScript
- スター
- 74
- フォーク
- 652
- 平均マージ
- 2日 50分
- マージ済み PR（30日）
- 12
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
moodle/devdocs のほかの issue
-
bug documentation help wanted needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
documentation enhancement help wanted needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
bug documentation help wanted needs-triage
難易度 1/5 1時間未満 初心者へのやさしさ 65/100
-
bug documentation good first issue needs-triage
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
-
bug documentation help wanted needs-triage
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
bug v2
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
modelcontextprotocol/inspector#2458 · コメント 1 件 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
railmapgen/rmp-gallery#4068 ·
-
Mend: dependency security vulnerability status: needs triage 🕵️♀️
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
carbon-design-system/ibm-products#9907 ·