Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update component documentation template #2787

Merged
merged 14 commits into from
Dec 22, 2023
Merged

Update component documentation template #2787

merged 14 commits into from
Dec 22, 2023

Conversation

mikearildbrown
Copy link
Contributor

This update

  • Updates the component documentation to reflect new practices
  • Adds a content style guide to the root folder with project-wide style rules
  • Adds a component doc template readme that explains to the reader step-by-step what to place where

@mikearildbrown mikearildbrown linked an issue Nov 24, 2023 that may be closed by this pull request
Update component documentation template #2754
Closed
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Nov 24, 2023 •
edited
Loading

⚠️ No Changeset found

Latest commit: 70d2f64

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

@vercel Vercel
Copy link

vercel bot commented Nov 24, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
saltdesignsystem ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 22, 2023 1:59pm

@mikearildbrown mikearildbrown mentioned this pull request Nov 24, 2023
Merged
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 24, 2023 •
edited
Loading

Storybook Preview Link https://7e58d6ca.saltdesignsystem-storybook.pages.dev

@mikearildbrown mikearildbrown marked this pull request as ready for review November 29, 2023 16:32
@mikearildbrown mikearildbrown self-assigned this Nov 29, 2023
james-nash
james-nash reviewed Dec 5, 2023
View reviewed changes
Copy link
Contributor

@james-nash james-nash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks pretty good. Just added a few small suggestions. Use them or not as you see fit :-)

content-style-guide.md Outdated Show resolved Hide resolved
content-style-guide.md Outdated Show resolved Hide resolved
templates/component-pages/README.md Outdated Show resolved Hide resolved
templates/component-pages/README.md Outdated Show resolved Hide resolved
templates/component-pages/README.md Outdated Show resolved Hide resolved
lilyvc
lilyvc reviewed Dec 18, 2023
View reviewed changes
content-style-guide.md Outdated Show resolved Hide resolved
@joshwooding joshwooding mentioned this pull request Dec 18, 2023
Merged
lilyvc
lilyvc reviewed Dec 18, 2023
View reviewed changes
content-style-guide.md Outdated Show resolved Hide resolved
lilyvc
lilyvc reviewed Dec 18, 2023
View reviewed changes
content-style-guide.md Outdated Show resolved Hide resolved
lilyvc
lilyvc reviewed Dec 18, 2023
View reviewed changes
content-style-guide.md Outdated Show resolved Hide resolved
james-nash
james-nash previously approved these changes Dec 19, 2023
View reviewed changes
Copy link
Contributor

@james-nash james-nash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work!

@lilyvc
Copy link
Contributor

lilyvc commented Dec 22, 2023

need to run yarn prettier

@lilyvc lilyvc merged commit a7c7236 into main Dec 22, 2023
11 checks passed
@lilyvc lilyvc deleted the update-component-documentation-template branch December 22, 2023 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lilyvc lilyvc lilyvc approved these changes

@feliciackh feliciackh feliciackh approved these changes

@james-nash james-nash Awaiting requested review from james-nash

Assignees

@mikearildbrown mikearildbrown

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update component documentation template
4 participants
@mikearildbrown @lilyvc @james-nash @feliciackh