feat(docs): add onboarding Storybook MDX docs (#612)#613
Open
MichaelLarocca wants to merge 1 commit intodevelopfrom
Open
feat(docs): add onboarding Storybook MDX docs (#612)#613MichaelLarocca wants to merge 1 commit intodevelopfrom
MichaelLarocca wants to merge 1 commit intodevelopfrom
Conversation
MichaelLarocca
requested review from
HoldUpFjord,
alexappleget,
bethanyann,
jennifertieu,
kepsteen,
nickytonline and
shashilo
as code owners
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
lillian-nguyen
requested changes
Sep 18, 2025
| @@ -0,0 +1,3 @@ | |||
| # Clone With Git | |||
Contributor
There was a problem hiding this comment.
We can consolidate the Clone with Git and CloneWithGitGraken files (e.g. "Cloning the Project")
Member
nickytonline
left a comment
nickytonline
left a comment
There was a problem hiding this comment.
Just some general feedback. Storybook is primarily used for showcasing components, design system related stuff, tests (if you leverage them in Storybook). Most of what's in this PR is OK, but it's not a replacement for a projects README/setup guide..
Clone with Git/Clone with GitKraken are better suited for a README or setup guide. Same for the Backend section since Storybook is mainly for frontend.
Thoughts @shashilo?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Before:
No onboarding documentation was available in Storybook. New contributors lacked a centralized place for project onboarding, standards, and technical references.
After:
Added onboarding documentation sections to Storybook using MDX files. Created the following docs in
stories/onboarding/:Updated Storybook config to ensure all onboarding docs are included in the sidebar. This provides a clear, accessible onboarding resource for new and existing team members.
Closes #612
Testing instructions
pnpm storybook.Additional information
[optional] Screenshots
Pre-submission checklist
feat(docs): add onboarding Storybook MDX docs (#612))Peer Code ReviewersandSenior+ Code Reviewersgroupsgis-code-questions