From 02c5e12df86b64123a69c01e145e0cdbf756e45a Mon Sep 17 00:00:00 2001 From: David Moore Date: Tue, 30 Sep 2025 13:32:33 +1000 Subject: [PATCH 1/2] docs: fixes to quickstart outputs --- docs/quickstart.mdx | 44 ++++++++++++++++++++++++-------------------- 1 file changed, 24 insertions(+), 20 deletions(-) diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 3731f7cd..4d2565d8 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -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. @@ -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: @@ -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: @@ -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" From a1f5ea40beaa61002537a092d925943d9feb7319 Mon Sep 17 00:00:00 2001 From: David Moore Date: Tue, 30 Sep 2025 13:34:17 +1000 Subject: [PATCH 2/2] fix spellcheck --- docs/.vale/styles/config/vocabularies/Suga/accept.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/.vale/styles/config/vocabularies/Suga/accept.txt b/docs/.vale/styles/config/vocabularies/Suga/accept.txt index 55688627..08dead35 100644 --- a/docs/.vale/styles/config/vocabularies/Suga/accept.txt +++ b/docs/.vale/styles/config/vocabularies/Suga/accept.txt @@ -17,6 +17,7 @@ Linode Vultr booleans CDNs +Addr # Defaults from mintlify Mintlify