Skip to content

Commit 9fe47d8

Browse files
Documentation edits made through Mintlify web editor
1 parent 9f9e9aa commit 9fe47d8

File tree

8 files changed

+190
-191
lines changed

8 files changed

+190
-191
lines changed

development.mdx

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ description: 'Preview changes locally to update your docs'
3333
mintlify dev
3434
```
3535

36-
Alternatively, if you do not want to install Mintlify globally you can use a run script available:
36+
If you prefer not to install Mintlify globally, you can use one of these available run scripts:
3737

3838
<CodeGroup>
3939
```bash npm
@@ -51,28 +51,28 @@ Alternatively, if you do not want to install Mintlify globally you can use a run
5151
</CodeGroup>
5252

5353
<Warning>
54-
Yarn's "dlx" run script requires yarn version >2. See [here](https://yarnpkg.com/cli/dlx) for more information.
54+
The Yarn "dlx" run script requires Yarn version >2. See the [Yarn documentation](https://yarnpkg.com/cli/dlx) for more information.
5555
</Warning>
5656

5757
A local preview of your documentation will be available at `http://localhost:3000`.
5858

5959
### Custom Ports
6060

61-
By default, Mintlify uses port 3000. You can customize the port Mintlify runs on by using the `--port` flag. To run Mintlify on port 3333, for instance, use this command:
61+
By default, Mintlify uses port 3000. You can customize the port by using the `--port` flag. For example, to run Mintlify on port 3333, use this command:
6262

6363
```bash
6464
mintlify dev --port 3333
6565
```
6666

67-
If you attempt to run Mintlify on a port that's already in use, it will use the next available port:
67+
If the specified port is already in use, Mintlify will automatically use the next available port:
6868

6969
```md
7070
Port 3000 is already in use. Trying 3001 instead.
7171
```
7272

7373
## Mintlify Versions
7474

75-
Please note that each CLI release is associated with a specific version of Mintlify. If your local website doesn't align with the production version, please update the CLI:
75+
Each CLI release is associated with a specific version of Mintlify. If your local website doesn't match the production version, update the CLI using one of these commands:
7676

7777
<CodeGroup>
7878

@@ -92,15 +92,15 @@ Please note that each CLI release is associated with a specific version of Mintl
9292

9393
## Validating Links
9494

95-
The CLI can assist with validating reference links made in your documentation. To identify any broken links, use the following command:
95+
The CLI includes a tool to help validate reference links in your documentation. To identify broken links, use this command:
9696

9797
```bash
9898
mintlify broken-links
9999
```
100100

101101
## Deployment
102102

103-
If the deployment is successful, you should see the following:
103+
A successful deployment will show this confirmation screen:
104104

105105
<Frame>
106106
<img
@@ -111,21 +111,24 @@ If the deployment is successful, you should see the following:
111111

112112
## Code Formatting
113113

114-
We suggest using extensions on your IDE to recognize and format MDX. If you're a VSCode user, consider the [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting, and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting.
114+
We recommend using IDE extensions to properly handle and format MDX files. For VSCode users, we suggest:
115+
116+
- The [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting
117+
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting
115118

116119
## Troubleshooting
117120

118121
<AccordionGroup>
119122
<Accordion title='Error: Could not load the "sharp" module using the darwin-arm64 runtime'>
120123

121-
This may be due to an outdated version of node. Try the following:
122-
1. Remove the currently-installed version of mintlify: `npm remove -g mintlify`
123-
2. Upgrade to Node v19 or higher.
124-
3. Reinstall mintlify: `npm install -g mintlify`
124+
This issue may be caused by an outdated version of Node.js. Try these steps:
125+
1. Remove the currently-installed version of Mintlify: `npm remove -g mintlify`
126+
2. Upgrade to Node.js v19 or higher
127+
3. Reinstall Mintlify: `npm install -g mintlify`
125128
</Accordion>
126129

127130
<Accordion title="Issue: Encountering an unknown error">
128131

129-
Solution: Go to the root of your device and delete the \~/.mintlify folder. Afterwards, run `mintlify dev` again.
132+
Solution: Navigate to the root of your device and delete the ~/.mintlify folder. Then run `mintlify dev` again.
130133
</Accordion>
131-
</AccordionGroup>
134+
</AccordionGroup>

mint.json

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,17 @@
6565
"icon": "pen-paintbrush",
6666
"pages": [
6767
"development",
68+
"web-editor",
69+
"reusable-snippets",
6870
"web-editor"
6971
]
7072
},
7173
"settings/global",
7274
"settings/navigation",
73-
"migration"
75+
"migration",
76+
"development",
77+
"settings/preview-deployments",
78+
"settings/seo"
7479
]
7580
},
7681
{
@@ -118,7 +123,9 @@
118123
"settings/add-members",
119124
"settings/github",
120125
"settings/gitlab",
121-
"settings/preview-deployments"
126+
"settings/preview-deployments",
127+
"settings/authentication",
128+
"settings/navigation"
122129
]
123130
},
124131
{

reusable-snippets.mdx

Lines changed: 24 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,24 @@ Yourself), which applies to documentation as
99
well. If you find yourself repeating the same content in multiple places, you
1010
should create a custom snippet to keep your content in sync.
1111

12-
## Creating a custom snippet
12+
## Creating a Custom Snippet
1313

14-
**Pre-condition**: You must create your snippet file in the `snippets` directory in order for the import to work.
14+
**Prerequisite**: You must create your snippet file in the `snippets` directory for the import to work.
1515

16-
Any page in the `snippets` directory will be treated as a snippet and will not
17-
be rendered into a standalone page. If you want to create a standalone page
18-
from the snippet, import the snippet into another file and call it as a
19-
component.
16+
Any page in the `snippets` directory will be treated as a snippet and will not
17+
be rendered as a standalone page. If you want to create a standalone page
18+
from the snippet, import the snippet into another file and use it as a
19+
component.
2020

21+
### Default Export
2122

22-
### Default export
23-
24-
1. Add content to your snippet file that you want to re-use. Optionally, you can add variables that can be filled in via props
25-
when you import the snippet. In this example, our variable is word.
23+
1. Add content to your snippet file that you want to reuse:
2624

2725
```typescript snippets/my-snippet.mdx
2826
Hello world! This is my content I want to reuse across pages.
2927
```
3028

31-
32-
2. Import the snippet into your destination file.
29+
2. Import the snippet into your destination file:
3330

3431
```typescript destination-file.mdx
3532
---
@@ -41,22 +38,21 @@ import MySnippet from '/snippets/path/to/my-snippet.mdx';
4138

4239
## Header
4340

44-
Lorem impsum dolor sit amet.
41+
Lorem ipsum dolor sit amet.
4542

4643
<MySnippet/>
4744

4845
```
4946

50-
### Exporting with variables
47+
### Exporting with Variables
5148

52-
1. Optionally, you can add variables that can be filled in via props when you import the snippet. In this example, our variable is word.
49+
1. Add variables that can be filled in via props when you import the snippet. In this example, our variable is `word`:
5350

5451
```typescript snippets/my-snippet.mdx
5552
My keyword of the day is {word}.
5653
```
5754

58-
59-
2. Import the snippet into your destination file with the variable. The property will fill in based on your specification.
55+
2. Import the snippet into your destination file with the variable. The property will be filled based on your specification:
6056

6157
```typescript destination-file.mdx
6258
---
@@ -68,13 +64,13 @@ import MySnippet from '/snippets/path/to/my-snippet.mdx';
6864

6965
## Header
7066

71-
Lorem impsum dolor sit amet.
67+
Lorem ipsum dolor sit amet.
7268

7369
<MySnippet word="bananas" />
7470

7571
```
7672

77-
### Reusable variables
73+
### Reusable Variables
7874

7975
1. Export a variable from your snippet file:
8076

@@ -97,10 +93,10 @@ import { myName, myObject } from '/snippets/path/to/custom-variables.mdx';
9793
Hello, my name is {myName} and I like {myObject.fruit}.
9894
```
9995

100-
### Reusable components
96+
### Reusable Components
10197

10298
1. Inside your snippet file, create a component that takes in props by exporting
103-
your component in the form of an arrow function.
99+
your component as an arrow function:
104100

105101
```typescript snippets/custom-component.mdx
106102
export const MyComponent = ({ title }) => (
@@ -112,11 +108,11 @@ export const MyComponent = ({ title }) => (
112108
```
113109

114110
<Warning>
115-
MDX does not compile inside the body of an arrow function. Stick to HTML
116-
syntax when you can or use a default export if you need to use MDX.
111+
MDX does not compile inside the body of an arrow function. Use HTML
112+
syntax when possible, or use a default export if you need to use MDX.
117113
</Warning>
118114

119-
2. Import the snippet into your destination file and pass in the props
115+
2. Import the snippet into your destination file and pass in the props:
120116

121117
```typescript destination-file.mdx
122118
---
@@ -133,9 +129,9 @@ Lorem ipsum dolor sit amet.
133129

134130
### Client-Side Content
135131

136-
By default, Mintlify employs server-side rendering, generating content
137-
at build time. For client-side content loading, ensure to verify the
138-
`document` object's availability before initiating the rendering process.
132+
By default, Mintlify uses server-side rendering, generating content
133+
at build time. For client-side content loading, verify the
134+
`document` object's availability before initiating the rendering process:
139135

140136
```typescript snippets/client-component.mdx
141137
{/* `setTimeout` simulates a React.useEffect, which is called after the component is mounted. */}
@@ -153,4 +149,4 @@ export const ClientComponent = () => {
153149
return <div id="client-component"></div>
154150
}
155151
}
156-
```
152+
```

settings/authentication.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Customize how your team can login to your Mintlify dashboard"
44
icon: 'user-unlock'
55
---
66

7-
Mintlify supports single sign-on to your dashboard via SAML and OIDC. If you use Okta or Google Workspace, we have provider-specific documentation for setting up SSO, but if you use another provider, please contact us!
7+
Mintlify supports Single Sign-On (SSO) to your dashboard via SAML and OIDC. If you use Okta or Google Workspace, we have provider-specific documentation for setting up SSO. If you use another provider, please contact us!
88

99
<Note>
1010
SSO functionality is available on our Enterprise plan. [Contact
@@ -20,18 +20,18 @@ Mintlify supports single sign-on to your dashboard via SAML and OIDC. If you use
2020
Under `Applications`, click to create a new app integration using SAML 2.0.
2121
</Step>
2222
<Step title="Configure integration">
23-
Enter the following:
24-
* Single sign-on URL (provided by Mintlify)
23+
Enter the following information:
24+
* Single Sign-On URL (provided by Mintlify)
2525
* Audience URI (provided by Mintlify)
2626
* Name ID Format: `EmailAddress`
2727
* Attribute Statements:
28-
| Name | Name format | Value
28+
| Name | Name Format | Value
2929
| ---- | ----------- | -----
3030
| `firstName` | Basic | `user.firstName` |
3131
| `lastName` | Basic | `user.lastName` |
3232
</Step>
3333
<Step title="Send us your IdP information">
34-
Once the application is set up, navigate to the sign-on tab and send us the metadata URL.
34+
Once the application is set up, navigate to the Sign-On tab and send us the metadata URL.
3535
We'll enable the connection from our side using this information.
3636
</Step>
3737
</Steps>
@@ -43,11 +43,11 @@ Mintlify supports single sign-on to your dashboard via SAML and OIDC. If you use
4343
You should choose the `Web Application` application type.
4444
</Step>
4545
<Step title="Configure integration">
46-
Select the authorization code grant type and enter the Redirect URI provided by Mintlify.
46+
Select the Authorization Code grant type and enter the Redirect URI provided by Mintlify.
4747
</Step>
4848
<Step title="Send us your IdP information">
49-
Once the application is set up, navigate to the General tab and locate the client ID & client secret.
50-
Please securely provide us with these, along with your Okta instance URL (e.g. `<your-tenant-name>.okta.com`). You can send these via a service like 1Password or SendSafely.
49+
Once the application is set up, navigate to the General tab and locate the Client ID and Client Secret.
50+
Please securely provide us with these, along with your Okta instance URL (e.g., `<your-tenant-name>.okta.com`). You can send these via a service like 1Password or SendSafely.
5151
</Step>
5252
</Steps>
5353
</Tab>
@@ -65,23 +65,23 @@ Mintlify supports single sign-on to your dashboard via SAML and OIDC. If you use
6565
</Frame>
6666
</Step>
6767
<Step title="Send us your IdP information">
68-
Copy the provided SSO URL, Entity ID, and x509 certificate and send it to the Mintlify team.
68+
Copy the provided SSO URL, Entity ID, and X.509 certificate and send them to the Mintlify team.
6969
<Frame>
7070
![](/images/gsuite-saml-metadata.png)
7171
</Frame>
7272
</Step>
7373
<Step title="Configure integration">
74-
On the Service provider details page, enter the following:
74+
On the Service Provider details page, enter the following:
7575
* ACS URL (provided by Mintlify)
7676
* Entity ID (provided by Mintlify)
77-
* Name ID format: `EMAIL`
77+
* Name ID Format: `EMAIL`
7878
* Name ID: `Basic Information > Primary email`
7979

8080
<Frame>
8181
![](/images/gsuite-sp-details.png)
8282
</Frame>
8383

84-
On the next page, enter the following attribute statements:
84+
On the next page, enter the following Attribute Statements:
8585
| Google Directory Attribute | App Attribute |
8686
| -------------------------- | ------------- |
8787
| `First name` | `firstName` |
@@ -92,4 +92,4 @@ Mintlify supports single sign-on to your dashboard via SAML and OIDC. If you use
9292
</Steps>
9393
</Tab>
9494

95-
</Tabs>
95+
</Tabs>

0 commit comments

Comments
 (0)