Skip to content

docs: update usage documentation for invalid radio groups #2104

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

Merged
merged 1 commit into from
Aug 23, 2023

Conversation

jnjosh
Copy link
Collaborator

@jnjosh jnjosh commented Aug 18, 2023

Description

Related to documentation improvement in SWC PR, adobe/spectrum-web-components#3558 related to issue adobe/spectrum-web-components#3005. This improves the documentation for the radio buttons in an invalid state and adds a usage instruction.

How and where has this been tested?

Documentation only.

Regression testing

n/a

Screenshots

Screenshot 2023-08-18 at 5 06 13 PM

To-do list

  • I have read the contribution guidelines.

  • I have updated relevant storybook stories and templates.

  • I have tested these changes in Windows High Contrast mode.

  • If my change impacts other components, I have tested to make sure they don't break.

  • If my change impacts documentation, I have updated the documentation accordingly.

  • ✨ This pull request is ready to merge. ✨

@github-actions
Copy link
Contributor

github-actions bot commented Aug 18, 2023

🚀 Deployed on https://pr-2104--spectrum-css.netlify.app

@github-actions github-actions bot temporarily deployed to pull request August 18, 2023 21:13 Inactive
@castastrophe castastrophe added the run_vrt For use on PRs looking to kick off VRT label Aug 21, 2023
@github-actions github-actions bot removed the run_vrt For use on PRs looking to kick off VRT label Aug 21, 2023
Copy link
Contributor

@mlogsdon18 mlogsdon18 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! Only thing I noticed was that we don't have an Icon component page so your icon.html link does not work, so may just need to remove that one or link out to https://spectrum.adobe.com/page/iconography/

@jnjosh jnjosh force-pushed the jnjosh/invalid-radio-group-documentation branch from bf80bdf to b7acaa9 Compare August 21, 2023 16:15
@jnjosh
Copy link
Collaborator Author

jnjosh commented Aug 21, 2023

@mlogsdon18 Great catch! That's actually broken currently on the live site so I updated to remove the icon mention. The point here is that you should use Help Text in a Field group, so leaving it out makes sense in context. Open to thoughts on that.

@github-actions github-actions bot temporarily deployed to pull request August 21, 2023 16:22 Inactive
@github-actions github-actions bot temporarily deployed to pull request August 21, 2023 19:18 Inactive
@Westbrook
Copy link
Contributor

As these rules seem to no longer do anything, should they be removed?

https://github.com/adobe/spectrum-css/blob/main/components/radio/index.css#L283-L289

@jnjosh jnjosh force-pushed the jnjosh/invalid-radio-group-documentation branch 2 times, most recently from b7acaa9 to 6fcd619 Compare August 22, 2023 14:10
@github-actions github-actions bot temporarily deployed to pull request August 22, 2023 14:18 Inactive
@jnjosh jnjosh force-pushed the jnjosh/invalid-radio-group-documentation branch from 6fcd619 to a5139e8 Compare August 23, 2023 15:06
@jnjosh jnjosh changed the title fix(radio): update usage documentation for invalid radio groups docs: update usage documentation for invalid radio groups Aug 23, 2023
@github-actions github-actions bot temporarily deployed to pull request August 23, 2023 15:11 Inactive
@jnjosh jnjosh force-pushed the jnjosh/invalid-radio-group-documentation branch from a5139e8 to b3252ec Compare August 23, 2023 15:13
@github-actions github-actions bot temporarily deployed to pull request August 23, 2023 15:20 Inactive
@Rajdeepc Rajdeepc added the documentation Because documentation is important and shouldn't be broken label Aug 23, 2023
@pfulton pfulton merged commit 7f99d1c into main Aug 23, 2023
@pfulton pfulton deleted the jnjosh/invalid-radio-group-documentation branch August 23, 2023 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Because documentation is important and shouldn't be broken
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants