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.

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

feat(styles): add docs to index #11627

Merged
merged 3 commits into from
Jun 17, 2022
Merged

feat(styles): add docs to index #11627

merged 3 commits into from
Jun 17, 2022

Conversation

alisonjoseph
Copy link
Member

Closes #carbon-design-system/carbon-platform#890

Add usage, style, code, and accessibility documentation to each component in Carbon styles index following asset schema

Changelog

New

  • Add docs to each component that has corresponding docs inside carbon website repo

Copy link
Member

@mattrosno mattrosno left a comment

Choose a reason for hiding this comment

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

This looks great to me. Follows the spec.

Some background - this allows us to show component docs in platform while those docs still reside in the carbon-website repo. In the future, after platform is on Carbon's TLD, we can move these *.mdx files to this repo and in doing so, all of these paths would be relative.

@netlify
Copy link

netlify bot commented Jun 16, 2022

Deploy Preview for carbon-components-react ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit e0a4b5b
🔍 Latest deploy log https://app.netlify.com/sites/carbon-components-react/deploys/62acd4da29ed480009867360
😎 Deploy Preview https://deploy-preview-11627--carbon-components-react.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@netlify
Copy link

netlify bot commented Jun 16, 2022

Deploy Preview for carbon-elements ready!

Name Link
🔨 Latest commit e0a4b5b
🔍 Latest deploy log https://app.netlify.com/sites/carbon-elements/deploys/62acd4da08ea4b000825bf14
😎 Deploy Preview https://deploy-preview-11627--carbon-elements.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Copy link
Collaborator

@francinelucca francinelucca left a comment

Choose a reason for hiding this comment

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

this LGTM! niceee @alisonjoseph 🎉

@kodiakhq kodiakhq bot merged commit 08ee8d6 into carbon-design-system:main Jun 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

6 participants