diff --git a/quickstart.mdx b/quickstart.mdx index d9e1e62a..4dfcf960 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -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 +``` + **Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding.