docs: add storybook for docs components

Aperta
  • Qualcosa non va?
#760 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
storybook, typescript
Ambito
documentation, testing

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
TypeScript
Stelle
42
Fork
16
Merge medio
12h 36m
PR unite (30g)
151

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di e18e/framework-tracker

Tutte le issue di e18e/framework-tracker

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.