From 1fce2e9b57c30efd0064511f0ce9898797bac101 Mon Sep 17 00:00:00 2001 From: Rak Siva Date: Fri, 21 Nov 2025 14:49:29 +1100 Subject: [PATCH 1/2] fix: updates project setup instructions Provides clearer instructions for setting up a new project or initializing Suga in an existing project. --- docs/quickstart.mdx | 63 ++++++++++++++++++++++++++++++--------------- 1 file changed, 42 insertions(+), 21 deletions(-) diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 1f0e8ca..bfb6958 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -28,35 +28,53 @@ You'll see a confirmation: ✓ Logged in as User ``` -## Create Your Project +## Getting started with Suga -Create a new project from a template: +Suga can be initialized into an existing project, a new folder, or you can use the new command to scaffold a starter template. -```bash title="Create New Project" icon="sparkles" -suga new my-first-app -``` + + + Initialize Suga in your project directory: -Select any template you prefer: + ```bash title="Initialize in Existing Project" icon="folder-plus" + cd your-existing-app + suga init + ``` - - You're welcome to use frameworks or tools beyond what's listed in the Templates, consider them a starting point or example. - + This will create a `suga.yaml` file that describes your application's infrastructure requirements. + + + Create a new project from a template: -```bash -Welcome to Suga, this command will help you create a project from a template. -If you already have a project, run suga init instead. + ```bash title="Create New Project" icon="sparkles" + suga new my-first-app + ``` -Project name: my-first-app -Template: -➜ suga/go-standard - suga/python-django-pip - suga/python-fastapi-uv - suga/typescript-express + Select any template you prefer: -Template: suga/go-standard + + You're welcome to use frameworks or tools beyond what's listed in the Templates, consider them a starting point or example. + -✓ Project created! -``` + ```bash + Welcome to Suga, this command will help you create a project from a template. + If you already have a project, run suga init instead. + + Project name: my-first-app + Template: + ➜ suga/go-standard + suga/python-django-pip + suga/python-fastapi-uv + suga/typescript-express + + Template: suga/go-standard + + ✓ Project created! + ``` + + The template includes a pre-configured `suga.yaml` file with example infrastructure resources. + + ## Design Your Application @@ -76,6 +94,9 @@ The editor launches in your browser: Opening browser to the editor Use Ctrl-C to exit ``` + + If you initialized with `suga init`, you'll be prompted to select a target platform (e.g., `suga/aws@1` or `suga/gcp@1`) when opening the editor. + Use the visual editor to design your APIs, databases, storage, and other cloud resources with drag-and-drop simplicity. From 689831e76798b6a5c5d3bd474ec8e2a56f50868b Mon Sep 17 00:00:00 2001 From: Rak Date: Sat, 22 Nov 2025 08:27:04 +1100 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Jye Cusch --- docs/quickstart.mdx | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index bfb6958..6247c2c 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -30,10 +30,10 @@ You'll see a confirmation: ## Getting started with Suga -Suga can be initialized into an existing project, a new folder, or you can use the new command to scaffold a starter template. +Suga can be added to an existing project, a new folder, or you can use the Suga cli to start from a template. - + Initialize Suga in your project directory: ```bash title="Initialize in Existing Project" icon="folder-plus" @@ -43,6 +43,19 @@ Suga can be initialized into an existing project, a new folder, or you can use t This will create a `suga.yaml` file that describes your application's infrastructure requirements. + + Start a new project from scratch with Suga: + + ```bash title="Start with a Blank Project" icon="folder-plus" + # Create a new project folder and navigate to it + mkdir your-project && cd your-project + + # Initialize Suga + suga init + ``` + + This will create a `suga.yaml` file that describes your application's infrastructure requirements. + Create a new project from a template: