docs: Add 2nd-gen TypeScript style guide and Storybook docs automation#6067
docs: Add 2nd-gen TypeScript style guide and Storybook docs automation#6067caseyisonit merged 26 commits intomainfrom
Conversation
🦋 Changeset detectedLatest commit: 86d7e28 The changes in this PR will be included in the next version bump. This PR includes changesets to release 85 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
📚 Branch Preview Links🔍 First Generation Visual Regression Test ResultsWhen a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
Deployed to Azure Blob Storage: If the changes are expected, update the |
caseyisonit
added
Status:WIP
caseyisonit
added
High priority PR review
caseyisonit
requested review from
Rajdeepc,
marissahuysentruyt,
nikkimk,
rise-erpelding and
rubencarvalho
|
@rubencarvalho @nikkimk @rise-erpelding @marissahuysentruyt @Rajdeepc I have replied and addressed all feedback/questions but let me know if you want to chat more! @marissahuysentruyt for the table overflow issue we can come back to that in the storybook CSS clean up or the docs IA work, does that sound cool? @rubencarvalho for the questions about the other areas of standardization, lets capture that for a future sync OR in a ticket for milestone 3 for this to be additive. i would like to get this first pass in and then continue making improvements if that sounds cool to you too. @Rajdeepc The split out PRs did not include the feedback applied and i was already well through addressing feedback before my PTO so this is the easiest path forward for me. We can discuss this in retro about size, scope, and picking up someone else's branch/expectations if you do so. I understand you were trying to help by making the PR smaller to review but i would like to move forward with how the PR is staged currently and we learn from it moving forward. |
| } | ||
|
|
||
| /** | ||
| * @todo Migrate from update() to updated() for consistency with other |
There was a problem hiding this comment.
Question: What's the team's approach to tracking @todos ? How do you track when these items should be completed or if they have been?
There was a problem hiding this comment.
great question!! we do not currently have a formal process to track them short of searching @todo or addressing it when working in a file. this is something we still need to define and work out a process for moving forward!
marissahuysentruyt
left a comment
marissahuysentruyt
left a comment
There was a problem hiding this comment.
I'm not sure I've seen that YARN_LOG.txt file before! Was that an intentional addition to this PR? What do you use it for?
Claude found a few conflicts and left a few suggestions. 👍
9 participants
Description
Adds a comprehensive TypeScript style guide for 2nd-gen component development and automates publishing contributor docs to Storybook.
Motivation and context
Contributors (human and AI) need clear, consistent guidance for writing 2nd-gen components. This PR provides detailed conventions for file organization, class structure, decorators, types, and composition patterns—all based on the Badge component as the reference implementation.
Additionally, contributor docs are now automatically converted and displayed within Storybook, making them easier to discover and browse alongside component documentation.
Related issue(s)
Screenshots (if appropriate)
N/A - documentation changes
Author's checklist
Reviewer's checklist
patch,minor, ormajorfeaturesManual review test cases
Verify TypeScript guide renders correctly in Storybook
yarn storybookin2nd-gen/packages/swcVerify navigation structure is accurate
CONTRIBUTOR-DOCS/02_style-guide/02_typescript/README.mdDevice review
Summary of changes:
generate-contributor-docs.mjs