Skip to content

Conversation

brophdawg11
Copy link
Contributor

We previously skipped this because it resulted in an extra level of misleading react-router/index nesting in the docs:

Screenshot 2025-07-21 at 5 39 15 PM

I dug into typedoc a bit more and found out that the latest version has a @mergeModuleWith tag that we can leverage to get the layout we want:

Screenshot 2025-07-24 at 11 58 14 AM

I also moved to typedoc.mjs config files so we can add our own custom JSDoc tags and silence typedoc warning in the output (Encountered an unknown block tag @mode, etc.)

Copy link

changeset-bot bot commented Jul 24, 2025

⚠️ No Changeset found

Latest commit: f39f70a

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

Comment on lines +2 to +3
* @module index
* @mergeModuleWith react-router
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Flatten these APIs up into the main react-router module

@brophdawg11 brophdawg11 merged commit 6d34713 into dev Jul 25, 2025
8 checks passed
@brophdawg11 brophdawg11 deleted the brophdawg11/typedoc branch July 25, 2025 19:26
Copy link
Contributor

github-actions bot commented Aug 5, 2025

🤖 Hello there,

We just published version 7.8.0-pre.0 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

Copy link
Contributor

github-actions bot commented Aug 7, 2025

🤖 Hello there,

We just published version 7.8.0 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

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.

2 participants