docs: add storybook for docs components

Đang mở
  • Có gì không ổn?
#760 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
storybook, typescript
Lĩnh vực
documentation, testing

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
TypeScript
Star
42
Fork
16
Merge trung bình
12 giờ 36 phút
Pull request đã merge (30 ngày)
151

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của e18e/framework-tracker

Tất cả issue của e18e/framework-tracker

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.