docs: add additional JSDocs to NavigateOptions

[alexanderson1993]

These should appear both in VS Code and other IDEs, as well as in the reference docs website.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 057f879

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]

Awesome! Thanks @alexanderson1993, there's a lot of room for improvements like these, so thanks for helping chip away

[github-actions]

🤖 Hello there,

We just published version 7.1.2-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!

[github-actions]

🤖 Hello there,

We just published version 6.28.3-pre-v6.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!