Skip to content

Commit b4ff175

Browse files
Clarrify community != support (#621)
* Documentation edits made through Mintlify web editor * Update quickstart.mdx * Update quickstart.mdx * Update quickstart.mdx never liked this final line lmao --------- Co-authored-by: tiffany-mintlify <[email protected]>
1 parent b649d38 commit b4ff175

File tree

1 file changed

+44
-65
lines changed

1 file changed

+44
-65
lines changed

quickstart.mdx

Lines changed: 44 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ icon: "rocket"
99
className="block dark:hidden"
1010
src="https://mintlify-assets.b-cdn.net/hero-light.png"
1111
/>
12+
1213
<img
1314
className="hidden dark:block"
1415
src="https://mintlify-assets.b-cdn.net/hero-dark.png"
@@ -17,7 +18,7 @@ icon: "rocket"
1718

1819
## Getting Started
1920

20-
Welcome! Follow the instructions below to learn how to deploy, update and
21+
Welcome\! Follow the instructions below to learn how to deploy, update and
2122
supercharge your documentation with Mintlify.
2223

2324
### Creating the Repository
@@ -27,36 +28,33 @@ Mintlify docs are rendered from MDX files and configurations defined in our
2728
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.
2829

2930
<AccordionGroup>
30-
31-
<Accordion icon="message-bot" title="Install the GitHub app">
32-
31+
<Accordion title="Install the GitHub app" icon="message-bot">
3332
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.
3433

3534
<Frame>
36-
![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png)
35+
![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png)
3736
</Frame>
38-
3937
</Accordion>
38+
<Accordion title="Monorepo Setup" icon="code-branch">
39+
If you want your docs to live alongside your code as a monorepo setup, you
40+
can: 1. Move your docs content to your monorepo. 2. Specify the path to your
41+
`docs.json` in the
42+
[dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings)
4043

41-
<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)
46-
<Frame>
47-
<img
48-
alt="Monorepo setup"
49-
className="block dark:hidden"
50-
src="/images/monorepo-light.png"
51-
/>
52-
<img
53-
alt="Monorepo setup"
54-
className="hidden dark:block"
55-
src="/images/monorepo-dark.png"
56-
/>
57-
</Frame>
58-
</Accordion>
59-
44+
<Frame>
45+
<img
46+
alt="Monorepo setup"
47+
className="block dark:hidden"
48+
src="/images/monorepo-light.png"
49+
/>
50+
51+
<img
52+
alt="Monorepo setup"
53+
className="hidden dark:block"
54+
src="/images/monorepo-dark.png"
55+
/>
56+
</Frame>
57+
</Accordion>
6058
</AccordionGroup>
6159

6260
### Updating the Content
@@ -65,25 +63,18 @@ Mintlify enables you to easily customize the style, structure, and content of
6563
your docs.
6664

6765
<AccordionGroup>
68-
<Accordion icon="rectangle-terminal" title="Editing locally (recommended for developers)">
69-
66+
<Accordion title="Editing locally (recommended for developers)" icon="rectangle-terminal">
7067
1. Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
7168
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).
7269
3. Use your favorite IDE to open the repository.
7370
4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`.
7471

7572
Learn more about this in our [local development guide](/development).
76-
7773
</Accordion>
78-
79-
<Accordion icon="pen-to-square" title="Editing with the web editor">
80-
74+
<Accordion title="Editing with the web editor" icon="pen-to-square">
8175
Learn more about how to use the web editor on our [guide](/web-editor).
82-
8376
</Accordion>
84-
85-
<Accordion icon="palette" title="Customizing to your brand">
86-
77+
<Accordion title="Customizing to your brand" icon="palette">
8778
Easily customize colors, logos and buttons among other configurations in our `docs.json` file. Start with these basic configurations:
8879

8980
```json
@@ -102,11 +93,8 @@ your docs.
10293
```
10394

10495
A full list of supported configurations can be found at [global settings](/settings/global).
105-
10696
</Accordion>
107-
108-
<Accordion icon="pencil" title="Adding content">
109-
97+
<Accordion title="Adding content" icon="pencil">
11098
Add content with simple MDX files. Initiate your pages with this template:
11199

112100
```md
@@ -118,22 +106,16 @@ your docs.
118106
```
119107

120108
Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a [wide array of components](/content/components).
121-
122109
</Accordion>
123-
124-
<Accordion icon="rocket" title="Pushing changes">
125-
110+
<Accordion title="Pushing changes" icon="rocket">
126111
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).
127112

128-
<Frame>
129-
![Manual
130-
Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png)
131-
</Frame>
132-
113+
<Frame>
114+
![Manual
115+
Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png)
116+
</Frame>
133117
</Accordion>
134-
135-
<Accordion icon="code-branch" title="Generating API references">
136-
118+
<Accordion title="Generating API references" icon="code-branch">
137119
You can easily set up your API references using an OpenAPI document.
138120

139121
1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `docs.json` with a URL.
@@ -151,15 +133,11 @@ your docs.
151133
3. Finally, include the generated endpoint MDX files to your `docs.json` under `navigation`.
152134

153135
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).
154-
155136
</Accordion>
156-
157-
<Accordion icon="chart-simple" title="Adding analytics">
158-
137+
<Accordion title="Adding analytics" icon="chart-simple">
159138
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).
160139

161140
We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
162-
163141
</Accordion>
164142
</AccordionGroup>
165143

@@ -170,17 +148,18 @@ your docs.
170148

171149
### Publishing
172150

173-
<Accordion icon="star" title="Adding a custom domain">
151+
<Accordion title="Adding a custom domain" icon="star">
152+
Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.
174153

175-
Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.
154+
Navigate to your [dashboard settings](https://dashboard.mintlify.com/settings) to add a custom domain.
176155

177-
Navigate to your [dashboard settings](https://dashboard.mintlify.com/settings) to add a custom domain.
156+
<Frame>
157+
![Custom Domain](/images/custom-domain.png)
158+
</Frame>
159+
</Accordion>
178160

179-
<Frame>![Custom Domain](/images/custom-domain.png)</Frame>
161+
Congrats, you've set up your documentation on Mintlify\!
180162

181-
</Accordion>
163+
Need support or want to give some feedback? You can click `support` in the [dashboard](http://dashboard.mintlify.com) (bottom left corner) or reach out to [[email protected]](mailto:[email protected]).
182164

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-
165+
You can also join our [community](https://mintlify.com/community) to engage with other Mintlify users and stay up to date with the latest feature drops.

0 commit comments

Comments
 (0)