Skip to content
This repository was archived by the owner on Mar 17, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/.vale/styles/config/vocabularies/Suga/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Linode
Vultr
booleans
CDNs
Addr

# Defaults from mintlify
Mintlify
Expand Down
44 changes: 24 additions & 20 deletions docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,14 @@ Deploy your first application on the Suga platform in just a few steps. The Suga
```

The editor launches in your browser:

```bash
⚡ Suga Editor
Opening visual editor at http://localhost:3001
Press Ctrl+C to stop the editor
⚡ Suga 1.0.0
- Sync Port: 50127
- Dashboard: https://app.addsuga.com/your-team/dev?port=50127

Opening browser to the editor
Use Ctrl-C to exit
```

Use the visual editor to design your APIs, databases, storage, and other cloud resources with drag-and-drop simplicity.
Expand Down Expand Up @@ -164,19 +168,19 @@ Deploy your first application on the Suga platform in just a few steps. The Suga
Your application starts with hot reload:

```bash
⚡ Suga v1.0.0
- App: my-first-app
- Addr: http://localhost:50051
⚡ Suga 1.0.0
- App: my-first-app
- Addr: :50051

Services
Services

✓ Starting [api]
✓ Starting [app]

Entrypoints
Entrypoints

✓ Starting [main] http://localhost:4000
✓ Starting [ingress] http://localhost:3000

Use Ctrl-C to exit
Use Ctrl-C to exit
```

Test your application:
Expand Down Expand Up @@ -228,14 +232,14 @@ Deploy your first application on the Suga platform in just a few steps. The Suga

You'll see the build output as a terraform stack with everything needed to deploy your application to the cloud:
```bash
✓ Terraform generated successfully
output written to ./.suga/stacks/my-first-app-aws-12345

Next steps:
1. Run cd ./.suga/stacks/my-first-app-aws-12345 to move to the stack directory
2. Initialize the stack terraform init -upgrade
3. Optionally, preview with terraform plan
4. Deploy with terraform apply
✓ Terraform generated successfully
output written to terraform/stacks/my-first-app

Next steps:
1. Run cd terraform/stacks/my-first-app to move to the stack directory
2. Initialize the stack terraform init -upgrade
3. Optionally, preview with terraform plan
4. Deploy with terraform apply
```

Configure cloud provider credentials:
Expand All @@ -256,7 +260,7 @@ Deploy your first application on the Suga platform in just a few steps. The Suga
Deploy with Terraform:

```bash title="Navigate to Stack" icon="folder"
cd .suga/stacks/my-first-app-aws-*
cd terraform/stacks/my-first-app
```

```bash title="Initialize Terraform" icon="download"
Expand Down