Skip to content

Commit ca91910

Browse files
Improve quickstart documentation for better translatability (#750)
* Documentation edits made through Mintlify web editor * 💅 --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <[email protected]>
1 parent 50e374b commit ca91910

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

quickstart.mdx

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,42 @@ description: "Deploy your documentation in minutes"
44
icon: "rocket"
55
---
66

7-
This quickstart guide will walk you through the process of setting up and deploying your documentation site in just a few minutes.
7+
This quickstart guide shows you how to set up and deploy your documentation site in minutes.
88

9-
By the end of this guide, you'll have a live documentation site that's ready to customize and expand.
9+
After you complete this guide, you will have a live documentation site ready to customize and expand.
1010

1111
<Info>
1212

13-
**Prerequisites**: Before you begin, make sure to [create an account](https://mintlify.com/start) and complete onboarding.
13+
**Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding.
1414

1515
</Info>
1616

1717
## Getting Started
1818

19-
Once you've completed the onboarding process, your documentation site will be automatically deployed to a unique URL with the following format.
19+
After you complete the onboarding process, your documentation site will automatically deploy to a unique URL with this format:
2020

2121
```
2222
https://<your-project-name>.mintlify.app
2323
```
2424

25-
You can find your URL from the Overview page of the dashboard.
25+
Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/).
2626

2727
<Frame>
2828
<img src="/images/quickstart/mintlify-domain-light.png" alt="Mintlify Domain" className="block dark:hidden" />
2929
<img src="/images/quickstart/mintlify-domain-dark.png" alt="Mintlify Domain" className="hidden dark:block" />
3030
</Frame>
3131

32-
This URL is instantly available and will update whenever you make changes to your documentation. It's perfect for testing and sharing with your team during development.
32+
This URL becomes available immediately and updates when you make changes to your documentation. Use this URL for testing and sharing with your team during development.
3333

3434
### Install the GitHub App
3535

36-
Mintlify provides a GitHub App that automates the deployment process when you push changes to your repository.
36+
Mintlify provides a GitHub App that automates deployment when you push changes to your repository.
3737

38-
You can install the GitHub App by following the instructions from the onboarding checklist or from your dashboard.
38+
Install the GitHub App by following the instructions from the onboarding checklist or from your dashboard.
3939

4040
1. Navigate to **Settings** in your Mintlify dashboard.
4141
2. Select **GitHub App** from the sidebar.
42-
3. Select **Install GitHub App**. This will open a new tab to the GitHub App installation page.
42+
3. Select **Install GitHub App**. This opens a new tab to the GitHub App installation page.
4343
4. Select the organization or user account where you want to install the app. Then select the repositories that you want to connect.
4444

4545
<Frame>
@@ -48,38 +48,38 @@ You can install the GitHub App by following the instructions from the onboarding
4848
</Frame>
4949

5050
<Info>
51-
Remember to update the GitHub App permissions if you move the documentation to a different repository.
51+
Update the GitHub App permissions if you move your documentation to a different repository.
5252
</Info>
5353

5454
### Authorize your GitHub Account
5555

5656
1. Navigate to **Settings** in your Mintlify dashboard.
5757
2. Select **My Profile** from the sidebar.
58-
3. Select **Authorize GitHub account**. This will open a new tab to the GitHub authorization page.
58+
3. Select **Authorize GitHub account**. This opens a new tab to the GitHub authorization page.
5959

6060
<Info>
61-
You may need an admin for your GitHub organization to authorize your account depending on your organization's settings.
61+
An admin for your GitHub organization may need to authorize your account depending on your organization settings.
6262
</Info>
6363

6464
## Editing Workflows
6565

66-
Mintlify offers two different workflows for creating and maintaining your documentation.
66+
Mintlify offers two workflows for creating and maintaining your documentation.
6767

6868
<Card title="Code-based workflow" icon="terminal" horizontal href="#code-based-workflow">
69-
For developers who prefer working with their existing tools. Click to jump to section.
69+
For users who prefer working with existing tools in their local environment. Click to jump to this section.
7070
</Card>
7171

7272
<Card title="Web editor workflow" icon="mouse-pointer-2" horizontal href="#web-editor-workflow">
73-
For those who prefer a visual interface. Click to jump to section.
73+
For users who prefer a visual interface in their web browser. Click to jump to this section.
7474
</Card>
7575

7676
## Code-Based Workflow
7777

78-
The code-based workflow integrates with your existing development environment and Git repositories, making it ideal for technical teams who want to manage documentation alongside their code.
78+
The code-based workflow integrates with your existing development environment and Git repositories. This workflow is best for technical teams who want to manage documentation alongside code.
7979

8080
### Install the CLI
8181

82-
To work locally with your documentation, install the Command Line Interface (CLI), called [mint](https://www.npmjs.com/package/mint), by running the following command in your terminal:
82+
To work locally with your documentation, install the Command Line Interface (CLI), called [mint](https://www.npmjs.com/package/mint), by running this command in your terminal:
8383

8484
<CodeGroup>
8585

@@ -105,9 +105,9 @@ pnpm add -g mint
105105

106106
### Edit the Documentation
107107

108-
Now that your environment is set up, you can start editing your documentation files. As an example, let's update the title of the introduction page:
108+
After you set up your environment, you can start editing your documentation files. For example, update the title of the introduction page:
109109

110-
Open your repository created during onboarding, find the `introduction.mdx` file, and find the top of the file, that should look like this:
110+
Open your repository created during onboarding, find the `introduction.mdx` file, and find the top of the file:
111111

112112
```jsx introduction.mdx
113113
---
@@ -127,7 +127,7 @@ description: "This is the introduction to the documentation"
127127

128128
### Preview the Changes
129129

130-
To preview the changes locally, run the following command.
130+
To preview the changes locally, run this command:
131131

132132
```bash
133133
mint dev
@@ -142,27 +142,27 @@ Your preview will be available at `localhost:3000`.
142142

143143
### Push the Changes
144144

145-
When you're ready to publish your changes, simply push the changes to your repository.
145+
When you are ready to publish your changes, push the changes to your repository.
146146

147-
Mintlify will automatically detect the changes, build your documentation, and deploy the updates to your site. You can monitor the deployment status in your GitHub repository's commit history or the [dashboard](https://dashboard.mintlify.com).
147+
Mintlify automatically detects the changes, builds your documentation, and deploys the updates to your site. Monitor the deployment status in your GitHub repository commit history or the [dashboard](https://dashboard.mintlify.com).
148148

149-
Once the deployment is complete, your last update will be available at `<your-project-name>.mintlify.app`.
149+
After the deployment is complete, your latest update will be available at `<your-project-name>.mintlify.app`.
150150

151151
<Card title="Jump to adding a custom domain" icon="arrow-down" href="#adding-a-custom-domain" horizontal>
152-
Optionally skip the web editor workflow and jump to adding a custom domain.
152+
Optionally, skip the web editor workflow and jump to adding a custom domain.
153153
</Card>
154154

155155
## Web Editor Workflow
156156

157-
The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interface for creating and editing documentation. It's ideal for people who want to work in their web browser without additional local development tools.
157+
The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interface for creating and editing documentation. This workflow is best for people who want to work in their web browser without additional local development tools.
158158

159159
### Access the Web Editor
160160

161161
1. Log in to your [Mintlify Dashboard](https://dashboard.mintlify.com).
162162
2. Select **Editor** on the left sidebar.
163163

164164
<Info>
165-
If you haven't installed the GitHub App, you will be prompted to do so upon opening the web editor.
165+
If you have not installed the GitHub App, you will be prompted to install the app when you open the web editor.
166166
</Info>
167167

168168
<Frame>
@@ -172,7 +172,7 @@ The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interf
172172

173173
### Edit the Documentation
174174

175-
In the web editor, you can navigate your documentation files in the sidebar. Let's update the introduction page.
175+
In the web editor, you can navigate through your documentation files in the sidebar. Let's update the introduction page:
176176

177177
Find and click on `introduction.mdx` in the file explorer.
178178

@@ -184,14 +184,14 @@ Then, in the visual editor, update the title field to "Hello World".
184184
</Frame>
185185

186186
<Tip>
187-
The editor provides a rich set of formatting tools and components. Access them by typing "/" in the editor to open the command menu.
187+
The editor provides a rich set of formatting tools and components. Type <kbd>/</kbd> in the editor to open the command menu and access these tools.
188188
</Tip>
189189

190190
### Publish Your Changes
191191

192-
When you're satisfied with your edits, click the `Publish` button in the top-right corner.
192+
When you are satisfied with your edits, click the `Publish` button in the top-right corner.
193193

194-
Your changes will be deployed immediately to your documentation site.
194+
Your changes are immediately deployed to your documentation site.
195195

196196
For more details about using the web editor, including advanced features like slash commands and image uploads, see our [Web Editor documentation](/editor).
197197

@@ -206,7 +206,7 @@ To add a custom domain, go to `Settings` > `Custom Domain` from the dashboard.
206206
<img src="/images/quickstart/custom-domain-dark.png" alt="Custom Domain" className="hidden dark:block" />
207207
</Frame>
208208

209-
Enter your domain (e.g., docs.yourcompany.com) and follow the provided instructions to configure DNS settings with your domain provider.
209+
Enter your domain (for example, `docs.yourcompany.com`) and follow the provided instructions to configure DNS (Domain Name System) settings with your domain provider.
210210

211211
<Table>
212212
| Record Type | Name | Value | TTL |
@@ -215,12 +215,12 @@ Enter your domain (e.g., docs.yourcompany.com) and follow the provided instructi
215215
</Table>
216216

217217
<Info>
218-
DNS changes can take up to 48 hours to propagate, though they often complete much sooner.
218+
DNS changes can take up to 48 hours to propagate, though changes often complete much sooner.
219219
</Info>
220220

221221
## Next Steps
222222

223-
Congratulations! You've successfully deployed your documentation site with Mintlify. Here are some suggested next steps to enhance your documentation:
223+
Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation:
224224

225225
<Card title="Customize Your Theme" icon="paintbrush" href="themes" horizontal>
226226
Learn how to customize colors, fonts, and the overall appearance of your documentation site.
@@ -237,11 +237,11 @@ Congratulations! You've successfully deployed your documentation site with Mintl
237237

238238
## Troubleshooting
239239

240-
If you encounter any issues during the setup process, check our common troubleshooting solutions:
240+
If you encounter issues during the setup process, check these common troubleshooting solutions:
241241

242242
<AccordionGroup>
243243
<Accordion title="Local preview not working">
244-
Make sure you have Node.js v19+ installed and that you're running the `mint dev` command from the directory containing your `docs.json` file.
244+
Make sure you have Node.js v19+ installed and that you run the `mint dev` command from the directory containing your `docs.json` file.
245245
</Accordion>
246246
<Accordion title="Changes not reflecting on live site">
247247
Deployment can take upwards to a few minutes. Check your GitHub Actions (for code-based workflow) or deployment logs in the Mintlify dashboard to ensure there are no build errors.

0 commit comments

Comments
 (0)