Skip to content

Conversation

@brookslybrand
Copy link
Contributor

@brookslybrand brookslybrand commented Dec 3, 2025

The confusing example and broken link on this doc were brought to my attention: https://reactrouter.com/7.10.0/api/components/Form#discover

@changeset-bot
Copy link

changeset-bot bot commented Dec 3, 2025

⚠️ No Changeset found

Latest commit: 9a4e910

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

@brookslybrand
Copy link
Contributor Author

@brophdawg11 remind me

  1. Does this need a changeset since it updates the code's doc? I assume no, because it's still just documentation
  2. Does this need to point to dev?

I don't think I've actually updated any typedocs myself, so I can't remember if the flow is different than updating markdown files

@timdorr
Copy link
Member

timdorr commented Dec 3, 2025

I think this (and Link) needs a little more explanation added. What is being "discovered" here?

@brophdawg11
Copy link
Contributor

@timdorr good call - I added cross links to https://reactrouter.com/explanation/lazy-route-discovery for Link/Form

@brophdawg11
Copy link
Contributor

@brookslybrand

  1. No changeset needed - those are only needed for user-facing/functional changes that need to be communicated at release time.
  2. I make these types of comment-only changes right against main so they surface to user son thew site as fast as possible., Technically they touch source code but they don't change any runtime behavior so it doesn't get the behavior of main out of sync with anything 🤷 .

@brookslybrand
Copy link
Contributor Author

Awesome, thanks @brophdawg11, and thanks for improving the docs by including that link (good suggestion @timdorr)

@brookslybrand brookslybrand merged commit 41f410a into main Dec 4, 2025
5 checks passed
@brookslybrand brookslybrand deleted the brooks/form-discovery branch December 4, 2025 16:13
ynakoo pushed a commit to ynakoo/react-router that referenced this pull request Dec 4, 2025
* docs: improve Form component's discovery description

* Add cross-links

---------

Co-authored-by: Matt Brophy <[email protected]>
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.

4 participants