Skip to content

Conversation

@majiayu000
Copy link

@majiayu000 majiayu000 commented Dec 27, 2025

Summary

Updated the Radio component documentation to clarify its relationship with the Toggle component system.

Changes Made

  • docs/boilerplate/app/components/Radio.md:
    • Added explanation that Radio is a variant of the Toggle component
    • Documented the inputDetailStyle prop for customizing the dot indicator
    • Added usage example

Fixes #3021

@coolsoftwaretyler
Copy link
Contributor

Hey @majiayu000 - thanks for the PR. I don't think this actually resolves #3021, nor do I have any issue with the missing trailing slashes. The docs site redirects correctly. I think the original issue was saying the documentation itself is out of date.

Copy link
Contributor

@coolsoftwaretyler coolsoftwaretyler left a comment

Choose a reason for hiding this comment

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

This won't actually fix the original issue. Did you want to take a shot at improving the docs?

@majiayu000
Copy link
Author

Hi maintainers,

I noticed that Issue #3021 mentions the documentation content might be outdated (referring to an old version of the component before it was moved to Toggle).

My PR currently only fixes the trailing slash in the documentation URLs. I wanted to clarify:

  1. Is fixing the URL format (adding trailing slashes) sufficient for this issue?
  2. Or does the actual documentation content on docs.infinite.red need to be updated as well?

Please let me know if any additional changes are needed. Thanks!

@majiayu000 majiayu000 changed the title fix: documentation on radio component wrong docs: add trailing slashes to Toggle component documentation URLs Dec 29, 2025
@coolsoftwaretyler
Copy link
Contributor

H3y @majiayu000:

  1. No, the trailing slashes are not a problem. Check the link and you'll see it works either way.
  2. I think we may want to update the docs to clarify them.

- Add explanation that Radio is part of the Toggle component system
- Document the inputDetailStyle prop for customizing the dot indicator
- Add usage example

Fixes infinitered#3021
@majiayu000 majiayu000 force-pushed the fix/issue-3021-documentation-on-radio-compone branch from 93cb145 to d86d0d5 Compare December 29, 2025 15:16
@majiayu000
Copy link
Author

Thanks for the feedback! I've updated the PR to actually improve the Radio documentation:

  • Clarified that Radio is a variant of the Toggle component system
  • Documented the inputDetailStyle prop for customizing the dot indicator
  • Removed the unnecessary trailing slash changes

Let me know if you'd like any other adjustments!

@coolsoftwaretyler
Copy link
Contributor

Thanks @majiayu000 - I'll take a look.

@coolsoftwaretyler
Copy link
Contributor

Hey @majiayu000 - let's hold off on changes for now. I'm trying to understand the initial issue better, so I'm not sure what (if anything) we ought to change in the docs.

@majiayu000
Copy link
Author

@coolsoftwaretyler , I know. If you have any idea you can tell me. I can change this pr or close it .

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

documentation on radio component wrong

2 participants