Skip to content

Conversation

@quqjp
Copy link
Collaborator

@quqjp quqjp commented Dec 3, 2025

概要

  • Headingコンポーネントの仕様書を追加

変更内容

  • コンポーネントの仕様書を追加
  • props の説明記述
  • 合わせてStorybook Docsの更新
    • コード例の記載

…`ReactNode` to a type-only import so the component now documents its API in-code as required (`packages/component-ui/src/heading/heading.tsx:1`).

    - Authored a comprehensive Heading specification that follows the shared format (overview, props tables, state/style details, accessibility, usage examples, and update history) to live under `docs/component/heading-specification.md:1`.
    - Created Storybook docs that surface the detailed spec inline and provide a canonical code example plus the existing demo story (`packages/component-ui/src/heading/Docs.mdx:1`).
    - Introduced a “コンポーネント仕様” section in the repository README that links to the new spec so the documentation index stays discoverable (`README.md:5`).

    Tests: not run (docs/storybook-only changes). Consider running `yarn storybook` or `yarn lint` if you want to preview or validate the new docs locally.
@quqjp quqjp changed the base branch from feature/ai-work to main December 3, 2025 00:39
@quqjp quqjp changed the title - Added TSDoc-style descriptions for every Heading prop and switched … Heading|Add Dropdown Specification Dec 3, 2025
@quqjp quqjp marked this pull request as ready for review December 3, 2025 00:50
@github-actions
Copy link

github-actions bot commented Dec 3, 2025

Chromatic results

Outputs

Name Value
storybookUrl https://639bcc36e4bdc7deb6496ad2-nuqbzvtomm.chromatic.com/
buildUrl https://www.chromatic.com/build?appId=639bcc36e4bdc7deb6496ad2&number=1507
actualCaptureCount 8
changeCount 3
errorCount 0

@quqjp quqjp changed the base branch from main to feature/ai-work December 3, 2025 01:01
@quqjp quqjp changed the title Heading|Add Dropdown Specification Heading|Add Heading Specification Dec 3, 2025
@quqjp quqjp changed the title Heading|Add Heading Specification WIP|Heading|Add Heading Specification Dec 3, 2025
@quqjp quqjp changed the base branch from feature/ai-work to main December 5, 2025 01:01
@quqjp quqjp changed the title WIP|Heading|Add Heading Specification Heading|Add Heading Specification Dec 8, 2025
@quqjp quqjp requested a review from z-daichi December 8, 2025 06:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants