Refreshes documentation introduction

[jyecusch]

Updates the introduction page to better reflect Suga's value proposition.

• Refreshes the landing page to focus on core capabilities.
• Also enhances the nav to improve user context

[coderabbitai]

Walkthrough

• Replaced navigation dropdowns with anchors in docs/docs.json (renamed navigation.dropdowns → navigation.anchors, item key dropdown → anchor, removed description fields). Collapsed subgroup structures: moved guides/overview into Guides, added guides/local-database-setup; moved cli/introduction into Commands and removed cli/installation from CLI Reference. Deleted docs/index.mdx and added a new docs/introduction.mdx as the site’s introductory landing page.

Possibly related PRs

• rename migrate-existing guide to add-suga #26: Modifies Guides pages in docs/docs.json, overlapping changes to which guide pages are listed.
• Backend configuration guide #29: Updates Guides/navigation entries in docs/docs.json, intersecting with this PR’s Guides restructuring.
• docs: fix issues with layout and content found during review #53: Adjusts docs navigation around Getting Started/cli/installation, directly related to CLI Reference changes here.

Suggested labels

documentation

Suggested reviewers

• tjholm
• HomelessDinosaur

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title succinctly captures the main change—refreshing the documentation’s introduction—without unrelated details, making it clear and focused.
Description Check	✅ Passed	The description directly relates to the changeset by summarizing updates to the introduction page and navigation, matching the modifications in the PR.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

---

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: 2

🧹 Nitpick comments (3)

docs/index.mdx (3)

35-39: Minor wording nit: “Go net/http”.

“Go HTTP” → “Go net/http” is clearer to Go devs.

-- **Framework flexibility** - Works as an add-on to Express, Django, FastAPI, Go HTTP, and other frameworks
+- **Framework flexibility** - Works as an add-on to Express, Django, FastAPI, Go net/http, and other frameworks

---

96-114: Avoid stale version in sample output.

Use a placeholder to prevent future drift.

- ⚡ Suga v0.0.1
+ ⚡ Suga vX.Y.Z

---

138-143: Provider status claims—standardize and confirm.

Capitalize consistently and verify current availability before publishing.

-- **Azure** - Coming Soon
-- **Kubernetes** - Coming soon and BYO
+- **Azure** - Coming soon
+- **Kubernetes** - Coming soon (bring your own cluster)

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cb21a44 and 0402bac.

⛔ Files ignored due to path filters (1)

• docs/images/project-editor.webm is excluded by !**/*.webm

📒 Files selected for processing (2)

• docs/docs.json (2 hunks)
• docs/index.mdx (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

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

🪛 GitHub Check: Spell Check with Vale

docs/index.mdx

[failure] 151-151:
[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Pluggable'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Pluggable'?", "location": {"path": "docs/index.mdx", "range": {"start": {"line": 151, "column": 5}}}, "severity": "ERROR"}

🪛 GitHub Actions: Test Docs

docs/index.mdx

[error] 151-151: [Vale.Spelling] Did you really mean 'Pluggable'?

🔇 Additional comments (5)

docs/docs.json (3)

17-37: Anchors-based nav migration looks good.

The switch to navigation.anchors and the regrouping under Documentation reads clean and Mintlify-compatible.

---

23-35: All referenced docs pages exist; sidebar links are valid.

---

39-63: All CLI command pages verified – no missing docs.

docs/index.mdx (2)

43-53: Mintlify Steps usage LGTM.

Built-in / components require no import; content reads clearly.

---

57-78: CTA targets verified
Files docs/guides/add-suga.mdx and docs/quickstart.mdx exist.

[coderabbitai]

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

docs/docs.json (1)

39-63: Include missing CLI pages in docs navigation
Unreferenced files in docs/cli: auth.mdx, development.mdx, environment.mdx, installation.mdx, project.mdx, utilities.mdx. Either add these under “CLI Reference” in docs/docs.json or remove/rename them to match your CLI commands.

🧹 Nitpick comments (2)

docs/introduction.mdx (2)

17-33: Video: add MP4 fallback and fix non-standard height class

• Safari often needs MP4; add a second for better compatibility.
• Tailwind doesn’t ship h-15; use h-16 or an arbitrary value.

Apply:

-<div className="relative h-96 overflow-hidden">
+<div className="relative h-96 overflow-hidden">
   <video 
     className="w-full h-full object-cover object-top"
     autoPlay 
     loop 
     muted 
     playsInline
     preload="metadata"
     poster="/images/project-editor-poster.jpg"
     aria-label="Demo of the Suga visual project editor showing drag-and-drop infrastructure design"
   >
     <source src="/images/project-editor.webm" type="video/webm" />
+    <source src="/images/project-editor.mp4" type="video/mp4" />
     Your browser does not support the video tag.
   </video>
-  <div className="absolute bottom-0 left-0 right-0 h-15 bg-gradient-to-t from-white to-transparent dark:from-gray-900 pointer-events-none"></div>
+  <div className="absolute bottom-0 left-0 right-0 h-16 bg-gradient-to-t from-white to-transparent dark:from-gray-900 pointer-events-none"></div>
 </div>

---

97-114: Avoid hardcoding versions/URLs in terminal snippet

“Suga v0.0.1” and a fixed dashboard URL will stale quickly. Consider placeholders or omit.

- ⚡ Suga v0.0.1
+ ⚡ Suga vX.Y.Z
@@
-    - Dashboard: https://app.addsuga.com/dev
+    - Dashboard: https://app.addsuga.com/dev  # may vary

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0402bac and 4d142c2.

⛔ Files ignored due to path filters (1)

• docs/images/project-editor.webm is excluded by !**/*.webm

📒 Files selected for processing (3)

• docs/docs.json (2 hunks)
• docs/index.mdx (0 hunks)
• docs/introduction.mdx (1 hunks)

💤 Files with no reviewable changes (1)

• docs/index.mdx

🧰 Additional context used

🧠 Learnings (1)

📚 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/introduction.mdx

🔇 Additional comments (7)

docs/introduction.mdx (3)

1-5: Front matter looks good; consider SEO alignment

Title/description are clear. If indexing is enabled site-wide, ensure this page is the canonical landing page.

Do you intend “/” to resolve to this page after removing index.mdx? If not, we may need a redirect or a minimal index that links here.

---

139-144: Update Azure status in docs/introduction.mdx
Change line 142 from “Azure – Coming soon” to “Azure – Supported (see Terraform backend guide)” since Azure Storage backend is already documented in docs/guides/terraform-backend-config.mdx.

⛔ Skipped due to learnings

Learnt from: jyecusch
PR: nitrictech/suga#49
File: docs/quickstart.mdx:0-0
Timestamp: 2025-09-08T23:49:28.551Z
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.

---

73-79: All referenced templates are present. The suga templates output includes suga/typescript-express, suga/python-fastapi-uv, suga/python-django-pip, and suga/go-standard.

docs/docs.json (4)

17-37: Anchors/nav validation passed
All referenced pages exist—no missing docs.

---

10-14: Confirm production SEO robots directive
Verified docs/docs.json has seo.metatags.robots: "noindex". This will block search engines—if you intend the production site to be indexed, change to "index" or remove this override.

---

116-119: Confirm PostHog API key is public & add host config if needed
In docs/docs.json ensure the apiKey (phc_…) is a client-side public key for the correct project, and if you’re self-hosting PostHog, add a host property under integrations.posthog.

---

65-77: navigation.global.anchors is supported

Mintlify’s docs confirm you can define global anchors under navigation.global.anchors in docs.json (mintlify.com)

[nitric-bot]

🎉 This PR is included in version 0.0.5 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀