jsdoc for react router

[ducin]

I was writing some code using createFileRoute and found out that jsdoc is missing for params e.g. in https://github.com/TanStack/router/blob/main/packages/react-router/src/route.ts#L373-L409

I'd be happy to provide the missing jsdoc, but first:

1. I'd like to make sure it makes sense 😅
2. if there are any conventions/guidelines to follow, LMK
   TIA

[schiller-manuel]

we want this, we should however also make sure that our API docs (currently manually done in markdown) are generated from the source code alone.

cc @crutchcorn

[crutchcorn]

I don't think there inherently has to be a one-or-another here. I think that adding missing JSDoc stuff first is a pre-req to not massively degrading our API reference docs for query.

@ducin would you be willing to help us start that migration by adding as many JSDocs as you see fit?

[ducin]

@crutchcorn of course :) I see jsdoc as a major DX improvement.

I didn't get the "query" thing. Did you mean "docs for router"?

So I will just submit a PR with some missing jsdoc I find useful and we'll see how it goes - does that make sense @schiller-manuel @crutchcorn?

[schiller-manuel]

yes I think he meant router.

[ducin]

FWIW, my first jsdoc/doc PR is here: #3537