Conversation
|
Warning Rate limit exceeded@davemooreuws has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 45 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (8)
docs/quickstart.mdx (8)
16-36: Offer a non-interactive project creation example.Some users (CI, scripts) prefer a single command without prompts.
Apply:
```bash title="Create New Project" icon="sparkles" suga new my-first-app ``` + Or non-interactively: + ```bash title="Create New Project (non-interactive)" icon="terminal" + suga new my-first-app --template suga/go-standard --yes + ```Also applies to: 20-36
44-65: Clarify language runtimes and uv prerequisite.
- State minimum Node.js/Go/Python versions.
- Mention that uv must be installed (link later is fine) or default to pip.
Apply:
- <Tab title="Python"> + <Tab title="Python (3.11+ recommended)"> ```bash title="Install Dependencies (uv)" icon="package" uv sync ``` Or with pip: ```bash title="Install Dependencies (pip)" icon="package" pip install -r requirements.txt ```Also applies to: 51-58
72-91: Note project root requirement for editor.Make clear that suga edit should be run from the project root; otherwise users hit “no suga.yaml found.”
Apply:
- Open the visual editor: + From your project root, open the visual editor:
186-213: Clarify multi-target build/deploy flow.You configure multiple targets but the example proceeds with only AWS. Say explicitly that users should repeat the Terraform steps per target or select one target.
Apply:
- Generate Terraform configuration: + Generate Terraform configuration (repeat per target you plan to deploy): @@ - You'll see the build output: + You'll see the build output (example for AWS):And keep using the provider placeholder in paths, e.g., my-first-app-{provider}-….
Also applies to: 236-243
216-232: Add provider setup essentials.
- AWS: recommend setting a default region (AWS_REGION/AWS_DEFAULT_REGION).
- GCP: set project and enable required APIs.
- Azure: set subscription.
Apply:
<Tab title="AWS"> ```bash title="Configure AWS" icon="aws" - aws configure + aws configure + export AWS_REGION=us-east-1 ``` </Tab> <Tab title="GCP"> ```bash title="Configure GCP" icon="google" - gcloud auth application-default login + gcloud auth application-default login + gcloud config set project <YOUR_PROJECT_ID> + # Ensure required APIs are enabled (Compute, Cloud Storage, etc.) ``` </Tab> <Tab title="Azure"> ```bash title="Configure Azure" icon="microsoft" - az login + az login + az account set --subscription "<YOUR_SUBSCRIPTION_NAME_OR_ID>" ```
266-269: Add a costs reminder.Suggest noting that applying plans creates billable resources.
Apply:
<Warning> - Review the Terraform plan carefully before applying to understand what resources will be created in your cloud account. + Review the Terraform plan carefully before applying to understand what resources will be created and that costs may be incurred in your cloud account. </Warning>
272-278: Tighten accomplishment phrasing.Minor style polish for brevity.
Apply:
-- ✅ Created and configured a Suga application from a template -— ✅ Developed and tested your application locally with hot reload -- ✅ Generated production-ready Terraform infrastructure code -- ✅ Deployed your application to your chosen cloud provider +— ✅ Created a Suga app from a template +— ✅ Developed and tested locally with hot reload +— ✅ Generated Terraform infrastructure +— ✅ Deployed to your chosen cloud provider
6-10: State minimum required CLI version
Add “Requires Suga CLI >= 1.0.0” to the prerequisites Note in docs/quickstart.mdx to match the “⚡ Suga v1.0.0” snippet and keep docs/cli/installation.mdx aligned.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/quickstart.mdx(4 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
🪛 LanguageTool
docs/quickstart.mdx
[grammar] ~274-~274: There might be a mistake here.
Context: ...gured a Suga application from a template - ✅ Developed and tested your application ...
(QB_NEW_EN)
[grammar] ~275-~275: There might be a mistake here.
Context: ...your application locally with hot reload - ✅ Generated production-ready Terraform i...
(QB_NEW_EN)
[grammar] ~276-~276: There might be a mistake here.
Context: ...tion-ready Terraform infrastructure code - ✅ Deployed your application to your chos...
(QB_NEW_EN)
🔇 Additional comments (4)
docs/quickstart.mdx (4)
67-70: LGTM: succinct project structure note.
12-14: Mintlify Steps/Step usage looks correct.These built-ins don’t require imports; matches prior guidance for this repo.
Also applies to: 72-74, 144-146, 186-188
279-281: Verify support channels.
- Confirm support@addsuga.com is the correct contact email and unify any support@nitric.io references.
- Ensure https://github.com/nitrictech/suga is the active repository link.
- Add your community/chat link if one exists.
144-169: Verify CLI sample output URLs and ports. Confirm the Dashboard URL (https://app.addsuga.com/dev) and Addr port (http://localhost:50051) in docs/quickstart.mdx match the currentsuga devCLI output, and update as needed to keep consistency across README.md and docs.json.
raksiv
force-pushed
the
refactor-quickstart-guide
branch
2 times, most recently
from
a07eb23 to
8112fa0
Compare
davemooreuws
force-pushed
the
refactor-quickstart-guide
branch
2 times, most recently
from
2c2469b to
1d85737
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (3)
docs/quickstart.mdx (3)
109-135: Add a short note recommending major-version pinning.The examples pin to @1 (good). Add guidance so users don’t switch to @latest inadvertently. (Matches prior feedback.)
``` + <Tip> + We recommend pinning to a major version (e.g., <code>@1</code>) for stability and reproducible builds. + </Tip>
196-199: Azure is called “officially supported” here; maintainers said Azure isn’t supported yet.Please remove or mark Azure as “coming soon/preview” to avoid misleading users.
- <Note> - The template has been set up to use AWS, you can also use GCP or Azure. These targets are officially supported. - </Note> + <Note> + The template is set up for AWS. GCP is also supported. Azure support is not available yet. + </Note>
191-194: Don’t advertise Azure in targets until it’s supported.Remove the Azure target (or comment it as “coming soon”) to keep examples accurate.
targets: - suga/aws@1 - suga/gcp@1 - - suga/azure@1 + # - suga/azure@1 # coming soon
🧹 Nitpick comments (5)
docs/quickstart.mdx (5)
241-241: Normalize stack path style (use ./ prefix consistently).Earlier output uses
./.suga/...; mirror that here.- cd .suga/stacks/my-first-app-aws-* + cd ./.suga/stacks/my-first-app-aws-*
88-98: Avoid hardcoding the editor port; it can vary.Add a tiny note so users aren’t confused if it opens on a different port.
Press Ctrl+C to stop the editor ``` + <Tip> + The editor port may vary; the CLI prints the exact URL after launch. + </Tip>
51-58: Clarify uv is optional.A one-liner avoids confusion if uv isn’t installed.
- ```bash title="Install Dependencies (uv)" icon="package" + uv is optional; use pip below if you don't have it installed. + ```bash title="Install Dependencies (uv)" icon="package"
3-7: Tighten “multi‑cloud” wording to reflect current support.If Azure isn’t available yet, call out AWS and GCP explicitly.
-description: "Get started with Suga in minutes - build, test, and deploy cloud-native applications with automatic infrastructure generation." +description: "Get started with Suga in minutes—build, test, and deploy cloud‑native apps with automatic infrastructure generation and multi‑cloud deployment to AWS and GCP." -Deploy your first application on the Suga platform in just a few steps. The Suga CLI provides everything you need to build cloud-native applications with automatic infrastructure generation and multi-cloud deployment capabilities. +Deploy your first application on the Suga platform in just a few steps. The Suga CLI provides everything you need to build cloud‑native apps with automatic infrastructure generation and multi‑cloud deployment to AWS and GCP.
238-255: Consider adding a cleanup hint.A short note on
terraform destroyhelps users avoid lingering resources.terraform apply ``` Confirm when prompted: + + <Tip> + To remove all provisioned resources later, run <code>terraform destroy</code> from the same stack directory. + </Tip>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/quickstart.mdx(4 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
🔇 Additional comments (3)
docs/quickstart.mdx (3)
101-106: Nice touch with the live-edit note.Calling out that the editor syncs changes to suga.yaml is helpful.
170-179: Good quick test path.Simple curl check matches the default route and expected response.
101-102: docs/images/edit-design.png exists and the/images/edit-design.pnglink resolves correctly.
Co-authored-by: Ryan Cartwright <39504851+HomelessDinosaur@users.noreply.github.com>
davemooreuws
force-pushed
the
refactor-quickstart-guide
branch
from
b0779be to
495bf4d
Compare
|
🎉 This PR is included in version 0.0.5 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
5 participants
Overhauled this guide to be more inline with the other guides. e.g. using steps, and simplifying the language, code comparisons etc.