Generate extension docs from raw metadata

オープン
#1,143 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@makhnatkin がすでに取り組んでいます。

2026年6月10日 から。

評価

この issue はまだ評価されていません。

説明

documentation enhancement
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-gen and covered by focused tests.
主要言語
TypeScript
スター
428
フォーク
48
平均マージ
5日 15時間
マージ済み PR(30日)
47

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

gravity-ui/markdown-editor のほかの issue

gravity-ui/markdown-editor の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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