From 2b4fd6fa08e247f3166c3f2ba203e86233b616cb Mon Sep 17 00:00:00 2001 From: David Moore Date: Mon, 29 Sep 2025 09:25:05 +1000 Subject: [PATCH 1/3] docs: adds login instructions for quickstart suga login is required before commands in quickstart --- docs/cli.mdx | 3 +++ docs/quickstart.mdx | 41 ++++++++++++++++++++++++----------------- 2 files changed, 27 insertions(+), 17 deletions(-) diff --git a/docs/cli.mdx b/docs/cli.mdx index 8722e8fd..93e09358 100644 --- a/docs/cli.mdx +++ b/docs/cli.mdx @@ -17,6 +17,9 @@ The Suga CLI is a powerful tool for building, developing, and managing cloud-nat # Install the CLI brew install nitrictech/tap/suga +# Login to Suga +suga login + # Create a new project suga new my-app diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 46ec32be..ed844561 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -12,6 +12,25 @@ Deploy your first application on the Suga platform in just a few steps. The Suga + + Sign in to the Suga platform: + + ```bash title="Sign In to Suga" icon="user" + suga login + ``` + + You'll see a confirmation: + ```bash + ⚡ Suga Logging in... + + ✓ Logged in as User + ``` + + + Authentication is required to access templates and other Suga platform features. + + + Create a new project from a template: @@ -38,19 +57,6 @@ Deploy your first application on the Suga platform in just a few steps. The Suga - Log in and open the visual editor: - - ```bash title="Login to Suga" icon="user" - suga login - ``` - - You'll see a confirmation: - ```bash - ⚡ Suga Logging in... - - ✓ Logged in as User - ``` - Open the visual editor: ```bash title="Open Visual Editor" icon="edit" @@ -279,12 +285,13 @@ Deploy your first application on the Suga platform in just a few steps. The Suga ```mermaid graph TB -One["Created and configured a Suga application from a template"] ==> Two["Developed and tested your application locally with hot reload"] -Two ==> Three["Generated production-ready Terraform infrastructure code"] -Three ==> Four["Deployed your application to your chosen cloud provider"] +One["Signed in to the Suga platform"] ==> Two["Created and configured a Suga application from a template"] +Two ==> Three["Developed and tested your application locally with hot reload"] +Three ==> Four["Generated production-ready Terraform infrastructure code"] +Four ==> Five["Deployed your application to your chosen cloud provider"] classDef nitricGreen stroke:#25b355,stroke-width:2px -class One,Two,Three,Four nitricGreen +class One,Two,Three,Four,Five nitricGreen ``` From 7f84d0b68e762e77f1f9cae3e49a65527b0ea046 Mon Sep 17 00:00:00 2001 From: David Moore Date: Mon, 29 Sep 2025 10:22:16 +1000 Subject: [PATCH 2/3] docs: updates quickstart guide with storage example --- docs/quickstart.mdx | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index ed844561..59b3df48 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -174,20 +174,31 @@ Deploy your first application on the Suga platform in just a few steps. The Suga Entrypoints - ✓ Starting [main] http://localhost:3000 + ✓ Starting [main] http://localhost:4000 Use Ctrl-C to exit ``` Test your application: - ```bash title="Test Application" icon="check-circle" - curl http://localhost:3000/hello + ```bash title="Write to Storage" icon="upload" + curl -X POST http://localhost:4000/write/test.txt \ + -H "Content-Type: text/plain" \ + -d "Hello from Suga!" ``` Expected response: - ```json - {"message": "Hello World"} + ``` + File 'test.txt' written to bucket. + ``` + + ```bash title="Read from Storage" icon="download" + curl http://localhost:4000/read/test.txt + ``` + + Expected response: + ``` + Hello from Suga! ``` From 70cf13340638616ba1146dbaa8be5ceb449a8693 Mon Sep 17 00:00:00 2001 From: David Moore Date: Mon, 29 Sep 2025 10:22:47 +1000 Subject: [PATCH 3/3] docs: updates icons in quick-start to lucide --- docs/quickstart.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 59b3df48..3731f7cd 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -59,7 +59,7 @@ Deploy your first application on the Suga platform in just a few steps. The Suga Open the visual editor: - ```bash title="Open Visual Editor" icon="edit" + ```bash title="Open Visual Editor" icon="external-link" suga edit ``` @@ -126,25 +126,25 @@ Deploy your first application on the Suga platform in just a few steps. The Suga - ```bash title="Install Dependencies (node)" icon="cube" + ```bash title="Install Dependencies (node)" icon="package" suga generate --ts --ts-out ./suga/client npm install ``` - ```bash title="Install Dependencies (uv)" icon="cube" + ```bash title="Install Dependencies (uv)" icon="package" suga generate --python --python-out ./suga_gen uv sync ``` Or with pip: - ```bash title="Install Dependencies (pip)" icon="cube" + ```bash title="Install Dependencies (pip)" icon="package" suga generate --python --python-out ./suga_gen pip install -r requirements.txt ``` - ```bash title="Install Dependencies (go)" icon="cube" + ```bash title="Install Dependencies (go)" icon="package" suga generate --go --go-out ./suga --go-package-name suga go mod tidy ```