Skip to content

Commit fba20b9

Browse files
Documentation edits made through Mintlify web editor
1 parent 3799135 commit fba20b9

File tree

2 files changed

+42
-35
lines changed

2 files changed

+42
-35
lines changed

docs.json

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,10 @@
2222
{
2323
"group": "Editing",
2424
"icon": "pen-paintbrush",
25-
"pages": ["development", "web-editor"]
25+
"pages": [
26+
"development",
27+
"web-editor"
28+
]
2629
},
2730
"settings/global",
2831
{
@@ -36,7 +39,8 @@
3639
"navigation/localization"
3740
]
3841
},
39-
"migration"
42+
"migration",
43+
"quickstart"
4044
]
4145
},
4246
{
@@ -94,7 +98,10 @@
9498
{
9599
"group": "Custom Scripts",
96100
"icon": "code",
97-
"pages": ["advanced/custom/css", "advanced/custom/js"]
101+
"pages": [
102+
"advanced/custom/css",
103+
"advanced/custom/js"
104+
]
98105
},
99106
{
100107
"group": "Custom Subdirectory",
@@ -205,7 +212,7 @@
205212
"pages": [
206213
"integrations/analytics/overview",
207214
"integrations/analytics/amplitude",
208-
"integrations/analytics/clearbit",
215+
"integrations/analytics/clearbit",
209216
"integrations/analytics/fathom",
210217
"integrations/analytics/google-analytics",
211218
"integrations/analytics/google-tag-manager",
@@ -251,7 +258,9 @@
251258
"groups": [
252259
{
253260
"group": "Changelog",
254-
"pages": ["changelog/overview"]
261+
"pages": [
262+
"changelog/overview"
263+
]
255264
}
256265
]
257266
}
@@ -366,4 +375,4 @@
366375
"publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8"
367376
}
368377
}
369-
}
378+
}

quickstart.mdx

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,20 @@ icon: "rocket"
1717

1818
## Getting Started
1919

20-
Welcome! Follow the instructions below to learn how to deploy, update and
20+
Welcome! Follow the instructions below to learn how to deploy, update, and
2121
supercharge your documentation with Mintlify.
2222

2323
### Creating the Repository
2424

2525
Mintlify docs are rendered from MDX files and configurations defined in our
2626
[starter kit](https://github.com/mintlify/starter). We use GitHub to integrate
27-
your docs with your code, and make source control effortless. Onboard through the [dashboard](https://dashboard.mintlify.com) or clone our [starter kit](https://github.com/mintlify/starter) to get started.
27+
your docs with your code and make source control effortless. Get started by onboarding through the [dashboard](https://dashboard.mintlify.com) or cloning our [starter kit](https://github.com/mintlify/starter).
2828

2929
<AccordionGroup>
3030

3131
<Accordion icon="message-bot" title="Install the GitHub app">
3232

33-
Install our GitHub app to ensure that your updates are automatically deployed when you push changes. You can find the installation link in the [dashboard](https://dashboard.mintlify.com/settings), on the Settings page. Upon successful installation, a check mark will appear next to the commit hash of the repository.
33+
Install our GitHub app to ensure that your updates are automatically deployed when you push changes. You can find the installation link in the [dashboard](https://dashboard.mintlify.com/settings) on the Settings page. Upon successful installation, a check mark will appear next to the commit hash of the repository.
3434

3535
<Frame>
3636
![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png)
@@ -39,10 +39,10 @@ your docs with your code, and make source control effortless. Onboard through th
3939
</Accordion>
4040

4141
<Accordion icon="code-branch" title="Monorepo Setup">
42-
If you want your docs to live alongside your code as a monorepo setup, you
43-
can: 1. Move your docs content to your monorepo. 2. Specify the path to your
44-
`docs.json` in the
45-
[dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings)
42+
If you want your docs to live alongside your code in a monorepo setup, you can:
43+
1. Move your docs content to your monorepo
44+
2. Specify the path to your `docs.json` in the [dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings)
45+
4646
<Frame>
4747
<img
4848
alt="Monorepo setup"
@@ -67,24 +67,24 @@ your docs.
6767
<AccordionGroup>
6868
<Accordion icon="rectangle-terminal" title="Editing locally (recommended for developers)">
6969

70-
1. Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
71-
2. Once git is installed, clone your docs repository using `git clone <your-repo>`. If you haven't set it up yet, now would be a good time to do so with these [SSH keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent).
72-
3. Use your favorite IDE to open the repository.
73-
4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`.
70+
1. Install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
71+
2. Clone your docs repository using `git clone <your-repo>`. If you haven't set up Git yet, now would be a good time to do so with [SSH keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)
72+
3. Open the repository in your favorite IDE
73+
4. Install the Mintlify CLI to preview changes with `npm i -g mintlify`
7474

7575
Learn more about this in our [local development guide](/development).
7676

7777
</Accordion>
7878

7979
<Accordion icon="pen-to-square" title="Editing with the web editor">
8080

81-
Learn more about how to use the web editor on our [guide](/web-editor).
81+
Learn more about how to use the web editor in our [guide](/web-editor).
8282

8383
</Accordion>
8484

8585
<Accordion icon="palette" title="Customizing to your brand">
8686

87-
Easily customize colors, logos and buttons among other configurations in our `docs.json` file. Start with these basic configurations:
87+
Easily customize colors, logos, and buttons among other configurations in your `docs.json` file. Start with these basic configurations:
8888

8989
```json
9090
"name": "Your Company"
@@ -101,13 +101,13 @@ your docs.
101101
},
102102
```
103103

104-
A full list of supported configurations can be found at [global settings](/settings/global).
104+
A full list of supported configurations can be found in our [global settings](/settings/global).
105105

106106
</Accordion>
107107

108108
<Accordion icon="pencil" title="Adding content">
109109

110-
Add content with simple MDX files. Initiate your pages with this template:
110+
Add content with simple MDX files. Start your pages with this template:
111111

112112
```md
113113
---
@@ -123,40 +123,39 @@ your docs.
123123

124124
<Accordion icon="rocket" title="Pushing changes">
125125

126-
Once ready, commit and push your changes to update your docs site. Here is a [guide](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) on how to do that. If the GitHub app is unable to successfully deploy your changes, you can manually update your docs through our [dashboard](https://dashboard.mintlify.com).
126+
Once ready, commit and push your changes to update your docs site. Here is a [guide](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) on how to do that. If the GitHub app cannot successfully deploy your changes, you can manually update your docs through our [dashboard](https://dashboard.mintlify.com).
127127

128128
<Frame>
129-
![Manual
130-
Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png)
129+
![Manual Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png)
131130
</Frame>
132131

133132
</Accordion>
134133

135134
<Accordion icon="code-branch" title="Generating API references">
136135

137-
You can easily set up your API references using an OpenAPI document.
136+
You can easily set up your API references using an OpenAPI document:
138137

139-
1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `docs.json` with a URL.
138+
1. Add your `openapi.yaml` or `openapi.json` file into your docs repository, or define the `openapi` field in `docs.json` with a URL:
140139

141140
```json
142141
"openapi": "link-to-your-openapi-file"
143142
```
144143

145-
2. Use our [scraper](/api-playground/openapi/setup#autogenerate-files-recommended) to autogenerate your OpenAPI endpoints files as:
144+
2. Use our [scraper](/api-playground/openapi/setup#autogenerate-files-recommended) to autogenerate your OpenAPI endpoints files:
146145

147146
```bash
148147
npx @mintlify/scraping@latest openapi-file <path-or-url-to-openapi-file>
149148
```
150149

151-
3. Finally, include the generated endpoint MDX files to your `docs.json` under `navigation`.
150+
3. Include the generated endpoint MDX files in your `docs.json` under `navigation`
152151

153152
For a complete guide on using Mintlify with OpenAPI, check out [this guide](/api-playground/openapi/setup). [This guide](/api-playground/openapi/writing-openapi) explains how to configure your API authentication methods. For manual API references definition, explore [our syntax](/api-playground/overview).
154153

155154
</Accordion>
156155

157156
<Accordion icon="chart-simple" title="Adding analytics">
158157

159-
Our in-house analytics give you insights into page views, search analytics, session recordings and more. Access these on your [dashboard](https://dashboard.mintlify.com/analytics).
158+
Our in-house analytics give you insights into page views, search analytics, session recordings, and more. Access these on your [dashboard](https://dashboard.mintlify.com/analytics).
160159

161160
We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
162161

@@ -165,22 +164,21 @@ your docs.
165164

166165
<Note>
167166
We provide a white-glove migration service as part of our Enterprise plan.
168-
Interested? You can request it by [contacting us](mailto:[email protected]).
167+
Interested? You can [contact us](mailto:[email protected]).
169168
</Note>
170169

171170
### Publishing
172171

173172
<Accordion icon="star" title="Adding a custom domain">
174173

175-
Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.
174+
Integrate your docs into your website by hosting them on a custom domain. This feature is included in the free plan.
176175

177176
Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain.
178177

179178
<Frame>![Custom Domain](/images/custom-domain.png)</Frame>
180179

181180
</Accordion>
182181

183-
Congrats! You've set up your Mintlify Docs and it's looking amazing! Need
184-
support or want to give some feedback? You can join our
185-
[community](https://mintlify.com/community) or drop us an email at
186-
182+
Congratulations! You've set up your Mintlify docs, and they're looking amazing! Need
183+
support or want to give feedback? Join our [community](https://mintlify.com/community) or email us at
184+

0 commit comments

Comments
 (0)