Include react-router/dom APIs in typedoc #13509
Conversation
|
brophdawg11
force-pushed
the
brophdawg11/hydrated-router-docs
branch
from
3387bc8 to
ef05746
Compare
| @@ -1,5 +1,5 @@ | |||
| { | |||
| "entryPoints": ["./index.ts"], | |||
| "entryPoints": ["./index.ts", "./dom-export.ts"], | |||
There was a problem hiding this comment.
This doesn't do quite what I would have hoped :/. It adds another level of nesting under react-router:
Unsure if theres any way to flatten that to:
react-router
...All the current stuff
react-router/dom
...New Stuff
| import { HydratedRouter, RouterProvider } from "react-router/dom"; | ||
|
|
||
| // TODO: Confirm if this causes tree-shaking issues and if so, convert to named exports | ||
| export type * from "react-router"; | ||
| export * from "react-router"; | ||
|
|
||
| export type { RouterProviderProps }; | ||
| export type { HydratedRouterProps, RouterProviderProps }; |
There was a problem hiding this comment.
Exported so they get included in the typedoc output as a clickable link in the HydratedRouter page
|
Closing this out as the outcome isn't quite what we want - Ryan is going to take a look at the typedoc stuff |
Closes #13450
This doesn't work as well as I'd hoped - maybe we should just inline the docs now for
react-router/domexports?