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

docs(Slug): add dev docs to Slug overview #15812

Merged
merged 6 commits into from
Feb 28, 2024

Conversation

tw15egan
Copy link
Collaborator

Closes #15784

Adds in documentation regarding the usage of the Slug component and its props

Changelog

New

  • Documentation about how to use the Slug component and a few of its props

Changed

  • Added some doc-specific overrides for styles that were being affected.

Testing / Reviewing

Ensure the spelling/grammar is correct and the content makes sense. Is there anything else we are missing?

Copy link

netlify bot commented Feb 21, 2024

Deploy Preview for v11-carbon-react ready!

Name Link
🔨 Latest commit 29c8453
🔍 Latest deploy log https://app.netlify.com/sites/v11-carbon-react/deploys/65df5225bfd44c0007d578e8
😎 Deploy Preview https://deploy-preview-15812--v11-carbon-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 configuration.

@mattrosno
Copy link
Member

@tw15egan this is excellent. What about the other components? Are there docs explaining how to pass in a Slug component into the slug prop?

@tw15egan
Copy link
Collaborator Author

@mattrosno I can add that. Would it make sense to keep it all in this overview, or should I add it to the examples folder? I’ll add some DataTable docs as well

@mattrosno
Copy link
Member

@tw15egan at minimum, maybe something in all 4 Overviews, even if 3 of them just point you to the first that includes all documentation.

image

No strong preference here besides having something mentioned in all Overviews.

@tw15egan
Copy link
Collaborator Author

@mattrosno updated

Copy link
Contributor

@guidari guidari left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

packages/react/src/components/Slug/Slug-datatable.mdx Outdated Show resolved Hide resolved
packages/react/src/components/Slug/Slug-datatable.mdx Outdated Show resolved Hide resolved
packages/react/src/components/Slug/Slug.mdx Outdated Show resolved Hide resolved
packages/react/src/components/Slug/SlugExamples.mdx Outdated Show resolved Hide resolved
packages/react/src/components/Slug/SlugForm.mdx Outdated Show resolved Hide resolved
packages/react/src/components/Slug/SlugForm.mdx Outdated Show resolved Hide resolved
packages/react/src/components/Slug/SlugExamples.mdx Outdated Show resolved Hide resolved
packages/react/src/components/Slug/Slug.mdx Outdated Show resolved Hide resolved
@tw15egan
Copy link
Collaborator Author

@mattrosno fixed 👍🏻

@tw15egan tw15egan requested a review from mattrosno February 28, 2024 15:35
@tay1orjones tay1orjones added this pull request to the merge queue Feb 28, 2024
Merged via the queue into carbon-design-system:main with commit 50c634e Feb 28, 2024
20 checks passed
@carbon-automation
Copy link
Contributor

Hey there! v11.52.0 was just released that references this issue/PR.

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

Successfully merging this pull request may close these issues.

[Feature Request]: Add developer documentation to the experimental Slug storybook
4 participants