chore: align reference headings, descriptions, structure #1815
Conversation
victoriaxyz
commented
Dec 16, 2024
•
victoriaxyz
commented
- align descriptions, headings, intro paragraphs
- add intro sentence for server-side methods
- use partials for hooks
- remove next steps section
|
Hey, here’s your docs preview: https://clerk.com/docs/pr/1815 |
victoriaxyz
changed the title
|
|
||
| ## Client-side helpers | ||
|
|
||
| Because the Next.js SDK is built on top of the Clerk React SDK, you can utilize the hooks that the React SDK provides. These hooks give you access to the [`Clerk`](/docs/references/javascript/clerk/clerk) object and a set of useful helper methods for signing in and signing up. Learn more about these hooks in the [React SDK reference](/docs/references/react/overview). |
There was a problem hiding this comment.
I think this description is helpful because when the users click on the links to the hooks, they're going to be confused why they just got taken to the React SDK docs. For now, we need to keep this context
docs/references/nextjs/overview.mdx
Outdated
| @@ -29,8 +29,6 @@ Clerk continues to provide drop-in support for the Next.js Pages Router. In addi | |||
| - [`getAuth()`](/docs/references/nextjs/get-auth) | |||
| - [`buildClerkProps()`](/docs/references/nextjs/build-clerk-props) | |||
|
|
|||
| ## Other references | |||
|
|
|||
| ### `Auth` object | |||
There was a problem hiding this comment.
this wouldn't be an h3 under "Server-side helpers" as its not a server-side helper, its an object.
same goes for clerkmiddleware - it wouldnt be an h3 under "server-side helpers" because its not a helper, its a middleware.
same goes for the demo repositories heading type (h3)
|
|
||
| ## Client-side helpers | ||
|
|
||
| The Clerk React Router SDK is built on top of the Clerk React SDK and provides access to all of Clerk React's hooks. These hooks give you access to the [`Clerk`](/docs/references/javascript/clerk/clerk) object and a set of useful helper methods for signing in and signing up. Learn more about these hooks in the [React SDK reference](/docs/references/react/overview). |
There was a problem hiding this comment.
same note here about keeping this context.
| @@ -12,23 +12,13 @@ Clerk makes it simple to add authentication to your TanStack Start application. | |||
|
|
|||
| ## Client-side helpers | |||
|
|
|||
| Because Clerk TanStack Start is a wrapper around Clerk React, you can utilize the hooks that Clerk React provides. These hooks give you access to the [`Clerk`](/docs/references/javascript/clerk/clerk) object, and a set of useful helper methods for signing in and signing up. You can learn more about these hooks [in the React SDK reference](/docs/references/react/overview). | |||
There was a problem hiding this comment.
same note about keeping the context
| @@ -23,7 +23,9 @@ Clerk Astro provides a set of useful [stores](https://github.com/nanostores/nano | |||
| - [`$sessionListStore`](/docs/references/astro/session-list-store) | |||
| - [`$organizationStore`](/docs/references/astro/organization-store) | |||
|
|
|||
| ## General Reference | |||
| ## Server-side helpers | |||
There was a problem hiding this comment.
I think the locals need to be added here, or somewhere on the page. Astro is on our list of going thru those docs and editing/validating them, but while we're here, we should do this right. we can pair on it if you want
