You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: integrations/sdks/stainless.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,7 @@ jobs:
46
46
commit_message: 'Auto-updates from Stainless'
47
47
```
48
48
49
-
This assumes the following secrets have been [uploaded to your Github Actions Secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions):
49
+
This assumes the following secrets have been [uploaded to your GitHub Actions Secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions):
50
50
51
51
- `secrets.STAINLESS_API_KEY`: Your Stainless API key.
52
-
- `secrets.API_TOKEN_GITHUB`: A Github [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) with permissions to push to your docs repo.
52
+
- `secrets.API_TOKEN_GITHUB`: A GitHub [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) with permissions to push to your docs repo.
Copy file name to clipboardExpand all lines: quickstart.mdx
+48-65Lines changed: 48 additions & 65 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,86 +20,63 @@ icon: "rocket"
20
20
Welcome! Follow the instructions below to learn how to deploy, update and
21
21
supercharge your documentation with Mintlify.
22
22
23
-
### 1. Deploying Your Docs Repository
23
+
### Creating the Repository
24
24
25
25
Mintlify docs are rendered from MDX files and configurations defined in our
26
-
[starter kit](https://github.com/mintlify/starter). We use Github to integrate
26
+
[starter kit](https://github.com/mintlify/starter). We use GitHub to integrate
27
27
your docs with your code, and make source control effortless.
28
28
29
29
<AccordionGroup>
30
-
<Accordionicon="github"title="Creating Your Documentation Repository">
30
+
<Accordionicon="github"title="Creating your documentation repository">
31
31
32
32
If you've created a docs repo in our onboarding, this step is complete. You can find your docs repository on your Mintlify [dashboard](https://dashboard.mintlify.com).
33
33
34
-
To create your docs repo without logging into Github, follow these instructions:
34
+
To create your docs repo without logging into GitHub, follow these instructions:
35
35
1. Clone our [starter template](https://github.com/mintlify/starter) into a new public repo. You can make the repo private later.
36
36
2. [Get in touch](mailto:[email protected]) with our team to deploy your repo.
The next step is to install our Github app. This ensures 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.
46
+
The next step is to install our GitHub app. This ensures 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.
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).
79
66
3. Use your favorite IDE to open the repository.
80
-
4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`. Learn more about this in our [development guide](/development).
81
-
82
-
**Editing Online:**
83
-
84
-
Here are two ways to edit your repository online:
85
-
86
-
* To edit a single file, locate and click the edit button. This will open a web editor right on Github.
* For a more versatile online experience, open your git repository in Github's [github.dev](https://github.dev) online IDE. Simply replace `github.com` in your repo URL with `github.dev`. For example, use `github.dev/mintlify/docs` instead of `github.com/mintlify/docs`.
67
+
4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`.
68
+
69
+
Learn more about this in our [local development guide](/development).
89
70
71
+
</Accordion>
90
72
73
+
<Accordionicon="pen-to-square"title="Editing with the web editor">
91
74
92
-
> **Monorepo Setup** <br/>
93
-
> We also support a mono-rep setup, allowing you to add our starter template within a docs folder in your existing repo.
94
-
> 1. Clone the starter template and move its contents into your docs folder
95
-
> 2. Delete the .git directory.
96
-
> 3. You can also choose the path to your mint.json in the dashboard under 'Settings' <br/>
97
-
>  <br/>
98
-
> The mono-repo setup eliminates the need for creating a new repo.
75
+
Learn more about how to use the web editor on our [guide](/web-editor).
99
76
100
77
</Accordion>
101
78
102
-
<Accordionicon="palette"title="Customizing Your Brand (mint.json)">
79
+
<Accordionicon="palette"title="Customizing to your brand">
103
80
104
81
Easily customize colors, logos and buttons among other configurations in our `mint.json` file. Start with these basic configurations:
105
82
@@ -118,11 +95,11 @@ your docs.
118
95
},
119
96
```
120
97
121
-
A full list of supported configurations can be found [here](/settings/global).
98
+
A full list of supported configurations can be found at [global settings](/settings/global).
122
99
123
100
</Accordion>
124
101
125
-
<Accordionicon="pencil"title="Adding Content">
102
+
<Accordionicon="pencil"title="Adding content">
126
103
127
104
Add content with simple MDX files. Initiate your pages with this template:
128
105
@@ -134,26 +111,21 @@ your docs.
134
111
---
135
112
```
136
113
137
-
Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a wide array of components which are listed [here](/content/components).
114
+
Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a [wide array of components](/content/components).
138
115
139
116
</Accordion>
140
117
141
-
<Accordionicon="rocket"title="Pushing Your Changes">
118
+
<Accordionicon="rocket"title="Pushing changes">
142
119
143
-
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).
120
+
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).
Mintlify supports an array of advanced features like API reference docs,
153
-
analytics, and versioning to accommodate any of your documentation needs.
154
-
155
-
<AccordionGroup>
156
-
<Accordionicon="code-branch"title="Generating API References">
128
+
<Accordionicon="code-branch"title="Generating API references">
157
129
158
130
You can easily set up your API references using an OpenAPI document.
159
131
@@ -175,22 +147,33 @@ analytics, and versioning to accommodate any of your documentation needs.
175
147
176
148
</Accordion>
177
149
178
-
<Accordionicon="star"title="Adding a Custom Domain">
179
-
180
-
Integrate your docs into your website by hosting them on a custom domain. This is included even in the free Mintlify plan. Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain.
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).
153
+
154
+
We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
183
155
184
156
</Accordion>
157
+
</AccordionGroup>
158
+
159
+
<Note>
160
+
We provide a white-glove migration service as part of our Enterprise plan.
161
+
Interested? You can request it by [contacting us](mailto:[email protected]).
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). We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
166
+
<Accordionicon="star"title="Adding a custom domain">
189
167
190
-
</Accordion>
191
-
</AccordionGroup>
168
+
Integrate your docs into your website by hosting them on a custom domain. This is included even in the free plan.
169
+
170
+
Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain.
171
+
172
+
<Frame>
173
+
174
+
</Frame>
192
175
193
-
### All Done!
176
+
</Accordion>
194
177
195
178
Congrats! You've set up your Mintlify Docs and it's looking amazing! Need
196
179
support or want to give some feedback? You can join our
Copy file name to clipboardExpand all lines: settings/add-members.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: 'Allow more members of your team to update your docs'
4
4
icon: 'user-group-simple'
5
5
---
6
6
7
-
The team member who created your initial docs will have update access to your docs, as long as they push to your documentation repo with the same Github account that was used while signing up for Mintlify.
7
+
The team member who created your initial docs will have update access to your docs, as long as they push to your documentation repo with the same GitHub account that was used while signing up for Mintlify.
8
8
9
9
If another editor attempts to update the docs while on the free plan, you will see a warning in your git commit check.
0 commit comments