Skip to content

Commit 60e5efb

Browse files
Documentation edits made through Mintlify web editor
1 parent 2b8729c commit 60e5efb

File tree

7 files changed

+14
-14
lines changed

7 files changed

+14
-14
lines changed

settings/authentication-personalization/authentication-setup/choosing-a-handshake.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,4 +81,4 @@ Before your users can access personalized content, they must be authenticated. M
8181

8282
- Requires all docs readers to have an account in your Mintlify dashboard
8383
</Tab>
84-
</Tabs>
84+
</Tabs>

settings/authentication-personalization/authentication-setup/jwt.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: 'Use a customized login flow to authenticate users'
77
This is the documentation for the JWT **Authentication** Handshake. The steps for setting up the [JWT **Personalization** Handshake](/settings/authentication-personalization/personalization-setup/jwt) are slightly different.
88
</Info>
99

10-
If you dont have a dashboard, or if you want to keep your dashboard and docs completely separate, you can use your own login flow to authenticate users via a JWT in the URL.
10+
If you don't have a dashboard, or if you want to keep your dashboard and docs completely separate, you can use your own login flow to authenticate users via a JWT in the URL.
1111

1212
## Implementation
1313

@@ -30,12 +30,12 @@ If you don’t have a dashboard, or if you want to keep your dashboard and docs
3030
## Example
3131

3232
I want to set up authentication for my docs hosted at `docs.foo.com`. I want my docs
33-
to be completely separate from my dashboard (or I dont have a dashboard at all).
33+
to be completely separate from my dashboard (or I don't have a dashboard at all).
3434

3535
To set up authentication with Mintlify, I go to my Mintlify dashboard and generate a
3636
JWT secret. I create a web URL `https://foo.com/docs-login` that initiates a login flow
3737
for my users. At the end of this login flow, once I have verified the identity of the user,
38-
I create a JWT containing the users custom data according to Mintlifys specification.
38+
I create a JWT containing the user's custom data according to Mintlify's specification.
3939
I use a JWT library to sign this JWT with my Mintlify secret, create a redirect URL of the
4040
form `https://docs.foo.com/login/jwt-callback#{SIGNED_JWT}`, and redirect the user.
4141

@@ -116,4 +116,4 @@ Example:
116116
* Redirect to login: [`https://foo.com/docs-login?redirect=%2Fquickstart`](https://foo.com/docs-login?redirect=%2Fquickstart)
117117

118118
After successful authentication, you can include this same `redirect` parameter in your JWT callback URL to send users to their intended destination:
119-
`https://docs.foo.com/login/jwt-callback?redirect=%2Fquickstart#{SIGNED_JWT}`
119+
`https://docs.foo.com/login/jwt-callback?redirect=%2Fquickstart#{SIGNED_JWT}`

settings/authentication-personalization/authentication-setup/mintlify.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,4 @@ my [dashboard settings](https://dashboard.mintlify.com/settings/organization/mem
4343
been added as users in your [Mintlify dashboard
4444
settings](https://dashboard.mintlify.com/settings/organization/members).
4545
</Step>
46-
</Steps>
46+
</Steps>

settings/authentication-personalization/authentication-setup/oauth.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ If you have an existing OAuth server, you can integrate with Mintlify for a seam
3737

3838
I have an existing OAuth server that supports the Authorization Code flow. I want to set up authentication for my docs hosted at `foo.com/docs`.
3939

40-
To set up authentication with Mintlify, I create an endpoint `api.foo.com/docs/user-info` which requires an OAuth access token with the `docs-user-info` scope, and responds with the user's custom data according to Mintlifys specification.
40+
To set up authentication with Mintlify, I create an endpoint `api.foo.com/docs/user-info` which requires an OAuth access token with the `docs-user-info` scope, and responds with the user's custom data according to Mintlify's specification.
4141

4242
I then go to the dashboard settings, navigate to the Authentication settings, select OAuth, and enter the relevant values for the OAuth flow and Info API endpoint:
4343
- **Authorization URL**: `https://auth.foo.com/authorization`
@@ -46,4 +46,4 @@ I then go to the dashboard settings, navigate to the Authentication settings, se
4646
- **Token URL**: `https://auth.foo.com/exchange`
4747
- **Info API URL**: `https://api.foo.com/docs/user-info`
4848

49-
Finally, I copy the Redirect URL displayed in the dashboard settings and add it as an authorized redirect URL in my OAuth client configuration settings.
49+
Finally, I copy the Redirect URL displayed in the dashboard settings and add it as an authorized redirect URL in my OAuth client configuration settings.

settings/authentication-personalization/authentication-setup/password.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ enough for my team.
4040

4141
To set up authentication with Mintlify, I go to my Mintlify dashboard and add at
4242
least one password. I then share that password, along with the private docs URL,
43-
with potential customers.
43+
with potential customers.

settings/authentication-personalization/personalization-setup/choosing-a-handshake.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,4 @@ Before your users can access personalized content, they must be authenticated. M
8282
- Dashboard sessions and docs authentication are completely decoupled, so users will need to log in to your dashboard and your docs separately
8383
- Might be overkill for some applications
8484
</Tab>
85-
</Tabs>
85+
</Tabs>

settings/authentication-personalization/personalization-setup/jwt.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: 'Use a customized login flow to authenticate users'
88
</Info>
99

1010

11-
If you dont have a dashboard, or if you want to keep your dashboard and docs completely separate, you can use your own login flow to send user info to your docs via a JWT in the URL.
11+
If you don't have a dashboard, or if you want to keep your dashboard and docs completely separate, you can use your own login flow to send user info to your docs via a JWT in the URL.
1212

1313
## Implementation
1414

@@ -31,12 +31,12 @@ If you don’t have a dashboard, or if you want to keep your dashboard and docs
3131
## Example
3232

3333
I want to set up authentication for my docs hosted at `docs.foo.com`. I want my docs
34-
to be completely separate from my dashboard (or I dont have a dashboard at all).
34+
to be completely separate from my dashboard (or I don't have a dashboard at all).
3535

3636
To set up authentication with Mintlify, I go to my Mintlify dashboard and generate a
3737
JWT secret. I create a web URL `https://foo.com/docs-login` that initiates a login flow
3838
for my users. At the end of this login flow, once I have verified the identity of the user,
39-
I create a JWT containing the users custom data according to Mintlifys specification.
39+
I create a JWT containing the user's custom data according to Mintlify's specification.
4040
I use a JWT library to sign this JWT with my Mintlify secret, create a redirect URL of the
4141
form `https://docs.foo.com#{SIGNED_JWT}`, and redirect the user.
4242

@@ -80,4 +80,4 @@ Post-login, if you'd like to redirect to a specific anchor on the page, you can
8080
Example:
8181

8282
- Original: `https://docs.foo.com/quickstart#step-one`
83-
- Redirect: `https://docs.foo.com/quickstart#jwt={SIGNED_JWT}&anchor=step-one`
83+
- Redirect: `https://docs.foo.com/quickstart#jwt={SIGNED_JWT}&anchor=step-one`

0 commit comments

Comments
 (0)