Generate extension docs from raw metadata

Abierto
#1,143 0 comentarios 0 reacciones 1 asignado Ver en GitHub

Los mantenedores suelen responder en 1 día

@makhnatkin ya está trabajando en esto.

Desde el 10/6/2026.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

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.
Lenguaje dominante
TypeScript
Estrellas
428
Forks
48
Merge medio
5 d 15 h
PR fusionados (30 d)
47

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de gravity-ui/markdown-editor

Todos los issues de gravity-ui/markdown-editor

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.