docs: adding generate command to quickstart docs

[sean-nitric]

adding in the generate commands so that the isntall goes smoothly.

This also requires us to run that after users have potentially updated and added more infra. So i flipped the order so you can play with it before the generate

[coderabbitai]

Walkthrough

Updated the quickstart flow: removed the Tip under “Select a template that matches your use case” and removed the original “Navigate to your project and install dependencies” section from “Create Your Project.” Added a new “Navigate to your project and install dependencies” subsection under “Develop Locally” that provides language-tabbed flows (Node.js, Python, Go). Each language flow runs a suga code-generation step prior to installing dependencies and includes install commands plus an Info blurb referencing project structure and suga.yaml. No changes to exported/public signatures.

Possibly related PRs

• Adds install card to CLI introduction and Reorders nav #58: Modifies docs/quickstart.mdx’s install/develop-local flow and is closely related to the restructuring and language-specific install/codegen steps.

Suggested labels

documentation

Suggested reviewers

• jyecusch
• raksiv
• tjholm

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The PR title "docs: adding generate command to quickstart docs" concisely and accurately summarizes the primary change—adding generate commands to the Quickstart documentation and related step reordering—matching the raw_summary and pr_objectives.
Description Check	✅ Passed	The PR description clearly states the intent to add generate commands and to reorder steps so users can update infra before running generate, which directly relates to the documented changes and therefore passes this lenient description check.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

---

📜 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 b8675a0 and f5aa204.

📒 Files selected for processing (1)

• docs/quickstart.mdx (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/quickstart.mdx

---

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.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (5)

docs/quickstart.mdx (5)

115-119: Clarify the step title to include codegen.

You’re running suga generate here; make the heading reflect that.

-  Navigate to your project and install dependencies:
+  Navigate to your project, generate SDKs, and install dependencies:

---

128-139: Match commands to templates; improve titles.

Add a one‑liner to guide uv vs pip; retitle blocks to reflect codegen.

       <Tab title="Python">
-        ```bash title="Install Dependencies (uv)" icon="cube"
+        Choose the command that matches your template (uv for FastAPI, pip for Django).
+        ```bash title="Generate SDK + install deps (uv)" icon="cube"
           suga generate --python --python-out ./suga_gen
           uv sync
         ```
 
         Or with pip:
-        ```bash title="Install Dependencies (pip)" icon="cube"
+        ```bash title="Generate SDK + install deps (pip)" icon="cube"
           suga generate --python --python-out ./suga_gen
           pip install -r requirements.txt
         ```

---

140-145: Go: remind about package name == module name.

Add a tip so users align --go-package-name with go.mod.

       <Tab title="Go">
         ```bash title="Install Dependencies (go)" icon="cube"
           suga generate --go --go-out ./suga --go-package-name suga
           go mod tidy
         ```
+        <Tip>Ensure <code>--go-package-name</code> matches your module name from <code>go.mod</code>.</Tip>
       </Tab>

---

148-151: Make Info actionable: call out when to re-run generate.

Helps prevent stale SDKs after editor changes.

-    <Info>
-      Your project structure will include `suga.yaml` for configuration, service code, and language-specific dependencies.
-    </Info>
+    <Info>
+      Your project includes <code>suga.yaml</code> for configuration. Re‑run
+      <code>suga generate</code> whenever you change <code>suga.yaml</code> or update your
+      architecture in the editor to refresh generated code.
+    </Info>

---

121-127: Retitle Node block; standardize suga generate flags/outputs.

Change quickstart Node tab title and align all suga generate examples to the canonical form in docs/cli/generate.mdx.

-        ```bash title="Install Dependencies (node)" icon="cube"
+        ```bash title="Generate SDK + install deps (Node)" icon="cube"
           suga generate --ts --ts-out ./suga
           npm install
         ```

• Found mixed flag forms (--ts/--ts-out/--python-out/--go-out vs --language/--output) and inconsistent output dirs (./suga, ./suga_gen, ./client, ./python-client, ./ts-client, ./go-client).
• Affected files to update: docs/quickstart.mdx, docs/sdks/node.mdx, docs/sdks/python.mdx, docs/sdks.mdx, docs/sdks/go.mdx, docs/cli/utilities.mdx, docs/cli/generate.mdx, docs/guides/add-suga.mdx.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 30e6df3 and 22e11ae.

📒 Files selected for processing (1)

• docs/quickstart.mdx (1 hunks)

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: davemooreuws
PR: nitrictech/suga#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.

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

Learnt from: davemooreuws
PR: nitrictech/suga#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

[nitric-bot]

🎉 This PR is included in version 0.0.11 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀