Skip to content

Add mermaid diagram of docs architecture to quickstart page #844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add mermaid diagram of docs architecture to quickstart page #844

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,40 @@ This quickstart guide shows you how to set up and deploy your documentation site

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

```mermaid
flowchart TD
A[GitHub Repository] -->|Push Changes| B[Mintlify Platform]
C[Local Development] -->|mint CLI| D[Local Preview]
C -->|Push to Git| A
E[Web Editor] -->|Direct Editing| B
B -->|Auto Deploy| F[Documentation Site]
B -->|Custom Domain| G[docs.yourcompany.com]
F -->|Default URL| H[project-name.mintlify.app]

subgraph "Development Workflows"
I[Code-based Workflow]
J[Web Editor Workflow]
end

I --> C
J --> E

subgraph "Mintlify Components"
B
K[GitHub App]
L[Dashboard]
end

A -->|Connected via| K
L -->|Manage Settings| B
L -->|Monitor Deployments| F

style A fill:#f9f9f9
style B fill:#e1f5fe
style F fill:#e8f5e8
style G fill:#e8f5e8
```

<Info>

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