Skip to content

Commit 4cbe451

Browse files
Add mermaid diagram visualizing docs architecture to quickstart page
1 parent 46d45b8 commit 4cbe451

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

quickstart.mdx

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,40 @@ This quickstart guide shows you how to set up and deploy your documentation site
88

99
After you complete this guide, you will have a live documentation site ready to customize and expand.
1010

11+
```mermaid
12+
flowchart TD
13+
A[GitHub Repository] -->|Push Changes| B[Mintlify Platform]
14+
C[Local Development] -->|mint CLI| D[Local Preview]
15+
C -->|Push to Git| A
16+
E[Web Editor] -->|Direct Editing| B
17+
B -->|Auto Deploy| F[Documentation Site]
18+
B -->|Custom Domain| G[docs.yourcompany.com]
19+
F -->|Default URL| H[project-name.mintlify.app]
20+
21+
subgraph "Development Workflows"
22+
I[Code-based Workflow]
23+
J[Web Editor Workflow]
24+
end
25+
26+
I --> C
27+
J --> E
28+
29+
subgraph "Mintlify Components"
30+
B
31+
K[GitHub App]
32+
L[Dashboard]
33+
end
34+
35+
A -->|Connected via| K
36+
L -->|Manage Settings| B
37+
L -->|Monitor Deployments| F
38+
39+
style A fill:#f9f9f9
40+
style B fill:#e1f5fe
41+
style F fill:#e8f5e8
42+
style G fill:#e8f5e8
43+
```
44+
1145
<Info>
1246

1347
**Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding.

0 commit comments

Comments
 (0)