Generate extension docs from raw metadata
メンテナーはふだん 1 日以内に返信
@makhnatkin がすでに取り組んでいます。
2026年6月10日 から。
評価
この issue はまだ評価されていません。
説明
What we want
- Continue the extension docs pipeline explored in #1067, but land it incrementally.
- Start with deterministic raw extraction: category, schema, actions, keymaps, plugins, options, examples, and presets.
- Use raw metadata as the base for generated Markdown docs and later enrichment/assembly steps.
- Make every generated artifact reviewable and easy to extend.
Why
- PR #1067 shows the full direction, but the pipeline is easier to review and stabilize in smaller parts.
- Manual docs drift from real extension APIs and behavior.
- A raw IR gives us a stable contract before adding AI-assisted or richer documentation layers.
Principles
- Source code is the source of truth.
- Prefer deterministic extraction first; keep enrichment explicit and optional.
- Extract only static, confident data; avoid guessing.
- Keep raw data separate from presentation.
- Keep docs-gen isolated in
infra/docs-genand covered by focused tests.
- 主要言語
- TypeScript
- スター
- 428
- フォーク
- 48
- 平均マージ
- 5日 15時間
- マージ済み PR(30日)
- 47
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
gravity-ui/markdown-editor のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
gravity-ui/markdown-editor#1452 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
gravity-ui/markdown-editor#1293 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
gravity-ui/markdown-editor#1129 ·
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 72/100
gravity-ui/markdown-editor#1450 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
gravity-ui/markdown-editor#1331 ·
メンテナーはふだん 1 日以内に返信
gravity-ui/markdown-editor の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
software-mansion/argent#1946 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 63/100
podman-desktop/podman-desktop#20216 ·
メンテナーはふだん 1 日以内に返信
-
[Type] Bug
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
WordPress/ai#1386 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 5 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
omdsh-dev/DSH-better-sidebar#1205 ·
メンテナーはふだん 3 日以内に返信