docs: updates project setup instructions

[raksiv]

Provides clearer instructions for setting up a new project or initializing Suga in an existing project.

[coderabbitai]

📝 Walkthrough

Well ackchyually…

Walkthrough

This change rewrites the quickstart into a tabbed "Getting started with Suga" flow (Initialize Suga to a Project, Start with an Empty Project, Start from Template), adjusts wording to emphasize that initialization creates a suga.yaml describing infrastructure requirements, adds notes about prompting for a target platform when running suga init, and updates template guidance to note templates include a pre-configured suga.yaml.

Possibly related PRs

• docs: update the quickstart guide with additional steps and ToC #116: Restructures docs/quickstart.mdx with overlapping tabbed UI and project-creation changes.
• docs: updating docs for launch #63: Edits docs/quickstart.mdx with related changes to template/init flow and suga.yaml references.
• docs: updates suga.yaml example in quickstart #104: Updates suga.yaml example/content in quickstart, closely related to the template/init documentation edits.

Suggested labels

documentation

Suggested reviewers

• tjholm
• HomelessDinosaur
• sean-nitric

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change—updating documentation for project setup instructions, which aligns with the core modification to the quickstart guide.
Description check	✅ Passed	The description is directly related to the changeset, explaining that clearer instructions are being provided for setting up a new project or initializing Suga, which matches the documented restructuring of the quickstart guide.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1fce2e9 and 689831e.

📒 Files selected for processing (1)

• docs/quickstart.mdx (2 hunks)

🧰 Additional context used

🧠 Learnings (5)

📓 Common learnings

Learnt from: davemooreuws
Repo: nitrictech/suga PR: 29
File: docs/guides/terraform-backend-config.mdx:0-0
Timestamp: 2025-08-28T06:12:17.266Z
Learning: The Suga project uses Mintlify for documentation. Mintlify provides built-in MDX components like <Steps> and <Step> that don't need to be defined or imported in the repository - they're available by default in Mintlify's documentation platform.

Learnt from: davemooreuws
Repo: nitrictech/suga PR: 86
File: cli/internal/devserver/editorsettings.go:100-103
Timestamp: 2025-09-25T22:25:02.513Z
Learning: In the Suga CLI project, editor settings (like selectedTarget) are stored per-project in the local project directory, not in a global user config directory. This allows different projects to have different editor configurations.

📚 Learning: 2025-08-28T06:12:17.266Z

Learnt from: davemooreuws
Repo: nitrictech/suga PR: 29
File: docs/guides/terraform-backend-config.mdx:0-0
Timestamp: 2025-08-28T06:12:17.266Z
Learning: The Suga project uses Mintlify for documentation. Mintlify provides built-in MDX components like <Steps> and <Step> that don't need to be defined or imported in the repository - they're available by default in Mintlify's documentation platform.

Applied to files:

• docs/quickstart.mdx

📚 Learning: 2025-09-25T22:25:02.513Z

Learnt from: davemooreuws
Repo: nitrictech/suga PR: 86
File: cli/internal/devserver/editorsettings.go:100-103
Timestamp: 2025-09-25T22:25:02.513Z
Learning: In the Suga CLI project, editor settings (like selectedTarget) are stored per-project in the local project directory, not in a global user config directory. This allows different projects to have different editor configurations.

Applied to files:

• docs/quickstart.mdx

📚 Learning: 2025-09-23T23:36:19.429Z

Learnt from: davemooreuws
Repo: nitrictech/suga PR: 74
File: cli/internal/simulation/simulation.go:85-85
Timestamp: 2025-09-23T23:36:19.429Z
Learning: In the Suga CLI, there are two different contexts for SugaIntro Dashboard output: 1) Simulation server (simulation.go) where Dashboard was correctly removed because it was non-functional, and 2) Development WebSocket server (suga.go) where Dashboard URL is valid and needed for syncing with the dashboard using team slug and port parameters.

Applied to files:

• docs/quickstart.mdx

📚 Learning: 2025-09-08T23:49:28.580Z

Learnt from: jyecusch
Repo: nitrictech/suga PR: 49
File: docs/quickstart.mdx:0-0
Timestamp: 2025-09-08T23:49:28.580Z
Learning: Suga currently only officially supports AWS (`suga/aws1`) and GCP (`suga/gcp1`) as deployment targets. Azure is not yet supported as a deployment target, despite `az login` being a valid Azure CLI authentication command.

Applied to files:

• docs/quickstart.mdx

🔇 Additional comments (2)

docs/quickstart.mdx (2)

31-90: Well ackchyually… the tabbed flow is well-structured and matches past reviewer feedback.

This reorg into tabs effectively covers all three project initialization paths and emphasizes the suga.yaml creation across each option. The structure aligns with previous suggestions and clarifies intent for different user scenarios (existing project, blank project, template).

---

110-112: Well ackchyually… the notation in quickstart.mdx is correct. The authoritative format is <team>/<platform>@<revision> (e.g., suga/aws@1), enforced by schema validation in cli/internal/platforms/repository.go and cli/pkg/schema/schema.go. The prior learnings documenting suga/aws1 are outdated.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[jyecusch]

Mostly suggesting we split the flow for:

• existing project - add suga
• blank project
• template project

[nitric-bot]

🎉 This PR is included in version 0.6.3 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀