docs: add storybook for docs components

Abierto
  • ¿Algo no está bien?
#760 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
storybook, typescript
Área
documentation, testing

Línea de trabajo

Start by reviewing dependency issue #759 and the Astro component scripts, then spike on ComparisonBarChart using the proposed @storybook-astro/framework. Verify it mounts in both storybook dev and a static build before adding stories for charts and tables with the Vitest fixtures. Done means stories cover every chart and table, both themes are selectable, the a11y addon is enabled, and CI fails on a broken Storybook build.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

enhancement

a visual catalog of the docs components would make it easier to see every chart and table in one place, check them in both themes and catch layout issues without clicking through the whole site.

there's no official storybook framework for astro, but @storybook-astro/framework supports astro 7 and storybook 10 and is actively maintained. the fixes for running component scripts landed recently though, so the first step is a quick spike on one chart (ComparisonBarChart) to make sure it mounts in both storybook dev and a static build.

plan:

  • spike on ComparisonBarChart
  • stories for every chart and table, reusing the vitest fixtures
  • theme toolbar + a11y addon
  • build storybook in ci so a broken story fails

if the spike doesn't hold up, the fallback would be a hidden gallery page inside the docs site.

depends on #759

Lenguaje dominante
TypeScript
Estrellas
42
Forks
16
Merge medio
12 h 36 min
PR fusionados (30 d)
151

Preparar el entorno

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 e18e/framework-tracker

Todos los issues de e18e/framework-tracker

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.