Skip to content

Commit 5fa58bd

Browse files
committed
Update quickstart website
1 parent b4d37f6 commit 5fa58bd

File tree

7 files changed

+64
-64
lines changed

7 files changed

+64
-64
lines changed
190 KB
Loading
202 KB
Loading
317 KB
Loading
277 KB
Loading
283 KB
Loading
332 KB
Loading

quickstart.mdx

Lines changed: 64 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,6 @@ description: "This is the introduction to the documentation"
112112
---
113113
```
114114

115-
116115
### Preview the changes
117116

118117
To preview the changes locally, run the following command.
@@ -137,87 +136,90 @@ Mintlify will automatically detect the changes, build your documentation, and de
137136
Once the deployment is complete, your last update will be available at `<your-project-name>.mintlify.app`.
138137

139138
<Card title="Jump to adding a custom domain" icon="arrow-down" href="#adding-a-custom-domain" horizontal>
140-
Skip the web editor workflow and jump to adding a custom domain.
139+
Optionally skip the web editor workflow and jump to adding a custom domain.
141140
</Card>
142141

143142
## Web Editor Workflow
144143

145-
The web editor workflow provides an intuitive interface for creating and editing documentation without requiring local development tools. It's ideal for non-technical team members or for making quick updates.
144+
The web editor workflow provides a WYSIWYG interface for creating and editing documentation without requiring local development tools. It's ideal for non-technical team members or for making quick updates.
145+
146+
### Access the Web Editor
147+
148+
Log in to your Mintlify Dashboard and select your project. Navigate to `Editor` on the left sidebar to open the web editor.
149+
150+
<Info>
151+
If you haven't installed the GitHub App, you will be prompted to do so upon opening the web editor.
152+
</Info>
146153

147-
<Steps>
148-
<Step title="Access the Web Editor">
149-
Log in to your Mintlify Dashboard and select your project. Click the Edit button to open the web editor.
150154
<Frame>
151-
<img alt="Web Editor Access" src="/images/web-editor-access.png" />
155+
<img alt="Web Editor" src="/images/quickstart/web-editor-light.png" className="block dark:hidden" />
156+
<img alt="Web Editor" src="/images/quickstart/web-editor-dark.png" className="hidden dark:block" />
152157
</Frame>
153-
</Step>
154-
<Step title="Make Changes to Your Documentation">
155-
In the web editor, you can navigate your documentation files in the sidebar. Let's update the introduction page:
156-
Find and click on introduction.mdx in the file explorer
157-
In the visual editor, update the title field to "Hello World"
158-
You'll see your changes reflected in the live preview on the right
159-
<Frame caption="Web Editor Interface">
160-
<img alt="Editing in Web Editor" src="/images/web-editor-interface.png" />
158+
159+
### Edit the documentation
160+
161+
In the web editor, you can navigate your documentation files in the sidebar. Let's update the introduction page.
162+
163+
Find and click on `introduction.mdx` in the file explorer.
164+
165+
Then, in the visual editor, update the title field to "Hello World".
166+
167+
<Frame>
168+
<img alt="Editing in Web Editor" src="/images/quickstart/web-editor-editing-light.png" className="block dark:hidden" />
169+
<img alt="Editing in Web Editor" src="/images/quickstart/web-editor-editing-dark.png" className="hidden dark:block" />
161170
</Frame>
171+
162172
<Tip>
163-
The editor provides a rich set of formatting tools and components. Access them by clicking the "+" button or typing "/" in the editor to open the command menu.
173+
The editor provides a rich set of formatting tools and components. Access them by typing "/" in the editor to open the command menu.
164174
</Tip>
165-
</Step>
166-
<Step title="Publish Your Changes">
167-
When you're satisfied with your edits:
168-
Click the Publish button in the top-right corner
169-
Review your changes in the confirmation dialog
170-
Add a commit message describing your updates
171-
Click Confirm and Publish
175+
176+
### Publish Your Changes
177+
178+
When you're satisfied with your edits, click the `Publish` button in the top-right corner.
179+
172180
Your changes will be deployed immediately to your documentation site.
173-
<Frame>
174-
<img alt="Publishing Changes" src="/images/web-editor-publish.png" />
175-
</Frame>
176-
<Note>
177-
For teams using Git workflows, the web editor can create branches and pull requests instead of publishing directly to the main branch. This allows for proper review processes.
178-
</Note>
179-
</Step>
180-
<Step title="Add a Custom Domain (Optional)">
181-
Just as with the code-based workflow, you can add a custom domain through the dashboard:
182-
From your Mintlify dashboard, go to Settings > Custom Domain
183-
Enter your domain (e.g., docs.yourcompany.com)
184-
Follow the provided instructions to configure DNS settings with your domain provider
185-
</Step>
186-
</Steps>
187-
For more details about using the web editor, including advanced features like slash commands and image uploads, see our Web Editor documentation.
188-
Next Steps
189-
Congratulations! You've successfully deployed your first documentation site with Mintlify. Here are some suggested next steps to enhance your documentation:
190-
<CardGroup cols={2}>
191-
<Card title="Customize Your Theme" icon="paintbrush" href="/core-concepts/styling/themes">
192-
Learn how to customize colors, fonts, and the overall appearance of your documentation site.
193-
</Card>
194-
<Card title="Organize Navigation" icon="sitemap" href="/core-concepts/navigation/overview">
195-
Structure your documentation with intuitive navigation to help users find what they need.
196-
</Card>
197-
<Card title="Add Interactive Components" icon="puzzle-piece" href="/components/accordions">
198-
Enhance your documentation with interactive components like accordions, tabs, and code samples.
199-
</Card>
200-
<Card title="Set Up API References" icon="code" href="/api-playground/overview">
201-
Create interactive API references with OpenAPI and AsyncAPI specifications.
202-
</Card>
203-
</CardGroup>
181+
182+
For more details about using the web editor, including advanced features like slash commands and image uploads, see our [Web Editor documentation](/editor).
204183

205184
## Adding a Custom Domain
206185

207-
While your `<name>.mintlify.app` subdomain works well for testing, most teams prefer using a custom domain for production documentation.
208-
From your Mintlify dashboard, go to Settings > Custom Domain
186+
While your `<your-project-name>.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation.
187+
188+
To add a custom domain, go to `Settings` > `Custom Domain` from the dashboard.
209189

210-
Enter your domain (e.g., docs.yourcompany.com)
211-
Follow the provided instructions to configure DNS settings with your domain provider
190+
<Frame>
191+
<img src="/images/quickstart/custom-domain-light.png" alt="Custom Domain" className="block dark:hidden" />
192+
<img src="/images/quickstart/custom-domain-dark.png" alt="Custom Domain" className="hidden dark:block" />
193+
</Frame>
194+
195+
Enter your domain (e.g., docs.yourcompany.com) and follow the provided instructions to configure DNS settings with your domain provider.
212196

213197
<Table>
214198
| Record Type | Name | Value | TTL |
215199
|-------------|------|-------|-----|
216200
| CNAME | docs (or subdomain) | cname.mintlify.app | 3600 |
217201
</Table>
218-
<Note>
219-
DNS changes can take up to 48 hours to propagate, though they often complete much sooner.
220-
</Note>
202+
203+
<Info>
204+
DNS changes can take up to 48 hours to propagate, though they often complete much sooner.
205+
</Info>
206+
207+
## Next Steps
208+
209+
Congratulations! You've successfully deployed your documentation site with Mintlify. Here are some suggested next steps to enhance your documentation:
210+
211+
<Card title="Customize Your Theme" icon="paintbrush" href="/core-concepts/styling/themes" horizontal>
212+
Learn how to customize colors, fonts, and the overall appearance of your documentation site.
213+
</Card>
214+
<Card title="Organize Navigation" icon="map" href="/core-concepts/navigation/overview" horizontal>
215+
Structure your documentation with intuitive navigation to help users find what they need.
216+
</Card>
217+
<Card title="Add Interactive Components" icon="puzzle" href="/components/accordions" horizontal>
218+
Enhance your documentation with interactive components like accordions, tabs, and code samples.
219+
</Card>
220+
<Card title="Set Up API References" icon="code" href="/api-playground/overview" horizontal>
221+
Create interactive API references with OpenAPI and AsyncAPI specifications.
222+
</Card>
221223

222224
## Troubleshooting
223225

@@ -236,6 +238,4 @@ Verify that your DNS records are set up correctly and allow sufficient time for
236238
</AccordionGroup>
237239

238240

239-
240-
241-
Need more help? Join our Community Discord or contact our Support Team.
241+
Need more help? [Contact our Support Team](mailto:[email protected]).

0 commit comments

Comments
 (0)