Skip to content

feat: proposal for a changelog tab viewer - #258

Draft
Fupete wants to merge 2 commits into
mainfrom
feat-add-changelog-viewer
Draft

feat: proposal for a changelog tab viewer#258
Fupete wants to merge 2 commits into
mainfrom
feat-add-changelog-viewer

Conversation

@Fupete

@Fupete Fupete commented Feb 5, 2026

Copy link
Copy Markdown
Contributor

PR Checklist

  • My branch is up-to-date with the Upstream main branch.
  • The unit tests pass locally with my changes (if applicable).
  • I have added tests that prove my fix is effective or that my feature works (if applicable).
  • I have added necessary documentation (if appropriate).

Short description of what this resolves:

Adds a changelog viewer to Storybook for easier tracking of component version history.

Changes proposed in this Pull Request:

  • Custom changelog addon displaying component-specific CHANGELOG.md files in a dedicated panel
  • Accordion UI matching Storybook's Accessibility addon style
  • Features: collapsible versions, markdown parsing, keyboard navigation, ARIA support

Screenshot:
Changelog addon in Storybook

Technical details:

  • Uses import.meta.glob to dynamically load component changelogs
  • Custom React addon in .storybook/addons/changelog-tab.tsx
  • Integrates with Changesets versioning system
  • Note: Required adding React and React-DOM as devDependencies for the custom addon (Storybook manager context seems to require React components)

Notes for team review:

This is a custom addon approach. Alternative solutions might exist:

  • Other Storybook changelog addons (e.g., storybook-addon-changelog-viewer seems incompatible with current Storybook version)
  • Native Storybook documentation features
  • MDX-based approaches
  • ...

The React dependency addition is not ideal (?). Alternative implementations that avoid this would be worth exploring.

No rush—please review and discuss alternatives before merging. Team feedback welcome.

@changeset-bot

changeset-bot Bot commented Feb 5, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 56c8f6a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@Fupete
Fupete marked this pull request as draft February 5, 2026 11:58
@vercel

vercel Bot commented Feb 5, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
design-web-components Ready Ready Preview Feb 5, 2026 11:58am

Request Review

@Fupete Fupete self-assigned this Feb 5, 2026
@Fupete Fupete added enhancement New feature or request documentation Improvements or additions to documentation labels Feb 5, 2026
@Fupete

Fupete commented Feb 5, 2026

Copy link
Copy Markdown
Contributor Author

@astagi dai un'occhiata a questa idea.
@pnicolli occhiata ed idee più che benvenute anche da parte vs, ma per ora è solo una PR draft per ragionare noi se ha senso l'idea.

@Fupete

Fupete commented Feb 6, 2026

Copy link
Copy Markdown
Contributor Author

Promemoria: valutare di fare in documentazione una scheda ad hoc Changelog più che un tab in ogni singola storia.

@Fupete

Fupete commented Jun 17, 2026

Copy link
Copy Markdown
Contributor Author

@giuliaghisini (cc @pnicolli) rispetto alla discussione nello spreadsheet si intendeva changelog a livello componente. Qui già implementata come tab. @pnicolli proponeva invece di implementarla come schedina ultima nella documentazione del componente. Quello sarebbe l'alternativa da valutare. (cc @astagi)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

Status: 🆕 New

Development

Successfully merging this pull request may close these issues.

1 participant