Skip to content

Commit d6df618

Browse files
committed
setup copyedits
1 parent 4a25bed commit d6df618

File tree

3 files changed

+22
-23
lines changed

3 files changed

+22
-23
lines changed

authentication-personalization/authentication-setup.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Select the handshake method that you want to configure.
4747

4848
Your documentation is hosted at `docs.foo.com` with an existing authentication system at `foo.com`. You want to extend your login flow to grant access to the docs while keeping your docs separate from your dashboard (or you don't have a dashboard).
4949

50-
To do this, create a login endpoint at `https://foo.com/docs-login` that extends your existing authentication.
50+
Create a login endpoint at `https://foo.com/docs-login` that extends your existing authentication.
5151

5252
After verifying user credentials:
5353
* Generate a JWT with user data in Mintlify's format.
@@ -153,7 +153,7 @@ When an unauthenticated user tries to access a protected page, their intended de
153153
</Step>
154154
</Steps>
155155

156-
## Example
156+
### Example
157157

158158
Your documentation is hosted at `foo.com/docs` and you have an existing OAuth server at `auth.foo.com` that supports the Authorization Code Flow.
159159

@@ -214,7 +214,7 @@ Password authentication provides access control only and does **not** support co
214214

215215
### Prerequisites
216216

217-
* Your security requirements allow password sharing among your users.
217+
* Your security requirements allow sharing passwords among users.
218218

219219
### Implementation
220220

authentication-personalization/partial-authentication-setup.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Partial authentication shares all the same features as authentication, but with
1010

1111
## Setup
1212

13-
Follow the [Authentication setup](/authentication-personalization/authentication-setup) guide and select **Partial Authentication** when configuring your chosen handshake method.
13+
Follow the [Authentication Setup](/authentication-personalization/authentication-setup) guide and select **Partial Authentication** when configuring your chosen handshake method.
1414

1515
## Making pages public
1616

17-
By default, all pages are protected. Add the `public` property to the page's frontmatter to make it viewable without authentication.
17+
By default, all pages are protected. Add the `public` property to the page's frontmatter to make it viewable without authentication:
1818

1919
```mdx
2020
---

authentication-personalization/personalization-setup.mdx

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Select the handshake method that you want to configure.
1616
<Tab title="JWT">
1717
### Prerequisites
1818

19-
* An login system that can generate and sign JWTs.
19+
* A login system that can generate and sign JWTs.
2020
* A backend service that can create redirect URLs.
2121

2222
### Implementation
@@ -81,14 +81,14 @@ export async function handleRequest(req: Request, res: Response) {
8181
To redirect users to specific sections after login, use this URL format: `https://docs.foo.com/page#jwt={SIGNED_JWT}&anchor={ANCHOR}`.
8282

8383
**Example**:
84-
- Original URL: `https://docs.foo.com/quickstart#step-one`
85-
- Redirect URL: `https://docs.foo.com/quickstart#jwt={SIGNED_JWT}&anchor=step-one`
84+
* Original URL: `https://docs.foo.com/quickstart#step-one`
85+
* Redirect URL: `https://docs.foo.com/quickstart#jwt={SIGNED_JWT}&anchor=step-one`
8686

8787
</Tab>
8888
<Tab title="OAuth 2.0">
8989
### Prerequisites
9090
* An OAuth server that supports the PKCE Flow.
91-
* Ability to create an API endpoint accessible by OAuth access tokens
91+
* Ability to create an API endpoint accessible by OAuth access tokens.
9292

9393
### Implementation
9494
<Steps>
@@ -132,11 +132,11 @@ Your documentation is hosted at `foo.com/docs` and you have an existing OAuth se
132132
```
133133

134134
**Configure your OAuth server details** in your dashboard:
135-
- **Authorization URL**: `https://auth.foo.com/authorization`
136-
- **Client ID**: `ydybo4SD8PR73vzWWd6S0ObH`
137-
- **Scopes**: `['docs-user-info']`
138-
- **Token URL**: `https://auth.foo.com/exchange`
139-
- **Info API URL**: `https://api.foo.com/docs/user-info`
135+
* **Authorization URL**: `https://auth.foo.com/authorization`
136+
* **Client ID**: `ydybo4SD8PR73vzWWd6S0ObH`
137+
* **Scopes**: `['docs-user-info']`
138+
* **Token URL**: `https://auth.foo.com/exchange`
139+
* **Info API URL**: `https://api.foo.com/docs/user-info`
140140

141141
**Configure your OAuth server** to allow redirects to your callback URL.
142142
</Tab>
@@ -159,21 +159,20 @@ Your documentation is hosted at `foo.com/docs` and you have an existing OAuth se
159159
* Uses your existing session authentication to identify users
160160
* Returns user data in the `User` format (see [Sending Data](/authentication-personalization/sending-data))
161161
* If the API domain and the docs domain **do not exactly match**:
162-
- Add the docs domain to your API's `Access-Control-Allow-Origin` header (must not be `*`).
163-
- Set your API's `Access-Control-Allow-Credentials` header to `true`.
162+
* Add the docs domain to your API's `Access-Control-Allow-Origin` header (must not be `*`).
163+
* Set your API's `Access-Control-Allow-Credentials` header to `true`.
164164

165165
<Warning>
166166
Only enable CORS headers on this specific endpoint, not your entire dashboard API.
167167
</Warning>
168168
</Step>
169169
<Step title="Configure your personalization settings">
170-
Go to your [dashboard settings](https://dashboard.mintlify.com/products/authentication) and add the API URL and your Login URL to your Personalization settings.
171170
1. In your dashboard, go to [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication).
172171
2. Select **Personalization**.
173172
3. Select **Shared Session**.
174173
4. Enter your **Info API URL**, which is the endpoint from the first step.
175-
5. Enter your **Login URL**, where users log in to your dashboard.
176-
6. Select **Save changes**
174+
5. Enter your **Login URL**, where users log into your dashboard.
175+
6. Select **Save changes**.
177176
</Step>
178177
</Steps>
179178

@@ -190,18 +189,18 @@ You have a dashboard at `dash.foo.com`, which uses cookie-based session authenti
190189
* `Access-Control-Allow-Credentials`: `true`
191190
3. **Configure API URL** in authentication settings: `https://dash.foo.com/api/docs/user-info`.
192191

193-
### Dashboard at subdomain, docs at root
192+
#### Dashboard at subdomain, docs at root
194193

195194
You have a dashboard at `dash.foo.com`, which uses cookie-based session authentication. Your dashboard API routes are hosted at `dash.foo.com/api`. You want to set up personalization for your docs hosted at `foo.com/docs`.
196195

197196
**Setup process**:
198197
1. **Create endpoint** `dash.foo.com/api/docs/user-info` that identifies users via session authentication and responds with their user data.
199198
2. **Add CORS headers** for this route only:
200-
- `Access-Control-Allow-Origin`: `https://foo.com`
201-
- `Access-Control-Allow-Credentials`: `true`
199+
* `Access-Control-Allow-Origin`: `https://foo.com`
200+
* `Access-Control-Allow-Credentials`: `true`
202201
3. **Configure API URL** in authentication settings: `https://dash.foo.com/api/docs/user-info`.
203202

204-
### Dashboard at root, docs at root
203+
#### Dashboard at root, docs at root
205204

206205
You have a dashboard at `foo.com/dashboard`, which uses cookie-based session authentication. Your dashboard API routes are hosted at `foo.com/api`. You want to set up personalization for your docs hosted at `foo.com/docs`.
207206

0 commit comments

Comments
 (0)