Skip to content

Commit 1b9ef7f

Browse files
fix(docs): update links, fix codeblocks, rephrase (#9566)
Co-authored-by: Balázs Orbán <[email protected]>
1 parent c3fb22e commit 1b9ef7f

File tree

2 files changed

+10
-16
lines changed

2 files changed

+10
-16
lines changed

docs/docs/reference/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ Here are the _state_ of planned and released packages under the `@auth/*` and `@
1414
| `next-auth` | Released (v4). See [docs](https://next-auth.js.org) |
1515
| `@auth/*-adapter` | Released (stable). Fully compatible with `next-auth` and all `@auth/*` libraries. |
1616
| `@next-auth/*-adapter` | Maintenance has stopped. Update to `@auth/*-adapter`. See above. |
17-
| `@auth/core` | Released (experimental). |
18-
| `@auth/sveltekit` | Released (experimental, [help needed](#help-needed)). |
19-
| `@auth/solid-start` | Released (experimental, [help needed](#help-needed)). Community package: [`@solid-mediakit/auth`](https://www.npmjs.com/package/@solid-mediakit/auth) |
20-
| `@auth/express` | Released (experimental, [help needed](#help-needed)). |
21-
| `@auth/remix` | Planned, [help needed](#help-needed). |
22-
| `@auth/astro` | Planned, [help needed](#help-needed). |
23-
| `@auth/nuxt` | Planned, [help needed](#help-needed). Community packages: [`@sidebase/nuxt-auth`](https://github.com/sidebase/nuxt-auth), [`@hebilicious/authjs-nuxt`](https://authjs-nuxt.pages.dev/) |
17+
| `@auth/core` | Released (experimental). See [docs](/reference/core) |
18+
| `@auth/sveltekit` | Released (experimental). See [docs](/reference/sveltekit) |
19+
| `@auth/solid-start` | Released (experimental). See [docs](/reference/solidstart) Community package: [`@solid-mediakit/auth`](https://www.npmjs.com/package/@solid-mediakit/auth) |
20+
| `@auth/express` | Released (experimental). See [docs](/reference/express) |
21+
| `@auth/remix` | Planned. |
22+
| `@auth/astro` | Planned. |
23+
| `@auth/nuxt` | Planned. Community packages: [`@sidebase/nuxt-auth`](https://github.com/sidebase/nuxt-auth), [`@hebilicious/authjs-nuxt`](https://authjs-nuxt.pages.dev/) |
2424

2525
:::info
2626
The NextAuth.js v4 documentation is at [next-auth.js.org](https://next-auth.js.org), while v5+ will be available [here](/reference/nextjs). Guides are being migrated over to the new documentation page and are gradually being updated to showcase all the framework integrations.

packages/frameworks-express/src/index.ts

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
* It provides a simple way to add authentication to your Express app in a few lines of code.
99
*
1010
* ## Installation
11-
* ```bash npm2yarn2pnpm
11+
* ```bash npm2yarn
1212
* npm install @auth/express
1313
* ```
1414
*
@@ -43,7 +43,7 @@
4343
*
4444
* Don't forget to set the `AUTH_SECRET` environment variable. This should be a minimum of 32 characters, random string. On UNIX systems you can use `openssl rand -hex 32` or check out `https://generate-secret.vercel.app/32`.
4545
*
46-
* You will also need to load the environment variables into the Node.js environment. You can do this using a package like [`dotenv`](https://www.npmjs.com/package/dotenv).
46+
* You will also need to load the environment variables into your runtime environment. For example in Node.js with a package like [`dotenv`](https://www.npmjs.com/package/dotenv) or `Deno.env` in Deno.
4747
*
4848
* ### Provider Configuration
4949
* The callback URL used by the [providers](https://authjs.dev/reference/core/modules/providers) must be set to the following, unless you mount the `ExpressAuth` handler on a different path:
@@ -53,7 +53,7 @@
5353
* ```
5454
*
5555
* ## Signing in and signing out
56-
* Once your application is mounted you can sign in or out by making requests to the following [REST API endpoints](https://next-auth.js.org/getting-started/rest-api) from your client-side code.
56+
* Once your application is mounted you can sign in or out by making requests to the following [REST API endpoints](https://authjs.dev/reference/core/types#authaction) from your client-side code.
5757
* NB: Make sure to include the `csrfToken` in the request body for all sign-in and sign-out requests.
5858
*
5959
* ## Managing the session
@@ -135,12 +135,6 @@
135135
* app.use("/protected", protected)
136136
* ```
137137
*
138-
* ## Notes
139-
*
140-
* :::info
141-
* PRs to improve this documentation are welcome! See [this file](https://github.com/nextauthjs/next-auth/blob/main/packages/frameworks-express/src/lib/index.ts).
142-
* :::
143-
*
144138
* @module @auth/express
145139
*/
146140

0 commit comments

Comments
 (0)