Adds install card to CLI introduction and Reorders nav

[davemooreuws]

Refactors the CLI documentation structure for better organization and discoverability.

• Moves the CLI introduction to the main cli.mdx file.
• Renames docs/guides/overview.mdx to docs/guides.mdx.
• Updates documentation links to reflect the new structure.
• Groups the CLI reference and CLI commands within the CLI tab in the navigation.
• Adds a card to the CLI introduction page that links to the CLI installation instructions

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This PR reorganizes documentation navigation and updates related pages. In docs/docs.json, the CLI tab switches from a flat pages list to grouped “CLI Reference” and “Commands,” removes cli/introduction, updates Getting Started to use installation (no cli/ prefix), revises Guides (replacing guides/overview, adding local-database-setup and aws/environment-management), and renames SDK groups to “SDK Reference” and “Languages.” Page updates: docs/cli.mdx adds an “Install Suga CLI” card linking to /installation. docs/guides.mdx, docs/guides/add-suga.mdx, and docs/quickstart.mdx update links from /cli/installation to /installation and adjust minor formatting.

Possibly related PRs

• docs: fix issues with layout and content found during review #53 — Modifies docs navigation and the same CLI docs/paths (cli/installation, cli/introduction), directly overlapping with this PR’s changes.
• Adds install card to CLI introduction and Reorders nav #58 — Restructures docs/docs.json and adds the Install card/link in docs/cli.mdx, matching changes in this PR.
• Refreshes documentation introduction #57 — Updates docs/docs.json navigation (CLI groups and guides) including adding guides/local-database-setup, overlapping with this PR.

Suggested labels

documentation

Suggested reviewers

• tjholm
• raksiv
• HomelessDinosaur

---

📜 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 6c26ebd and ac8da77.

📒 Files selected for processing (5)

• docs/cli.mdx (2 hunks)
• docs/docs.json (2 hunks)
• docs/guides.mdx (3 hunks)
• docs/guides/add-suga.mdx (6 hunks)
• docs/quickstart.mdx (12 hunks)

---

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 (2)

docs/cli/introduction.mdx (1)

10-12: Install card looks good; please verify Card props and align style.

• Ensure Mintlify’s Card supports icon="download" and the horizontal prop in your theme; otherwise build may fail. If unsupported, drop horizontal.
• Minor: other cards omit ending periods—match style for consistency.

-<Card title="Install Suga CLI" icon="download" href="/cli/installation" horizontal>
-  Install the Suga CLI on your system to get started.
+<Card title="Install Suga CLI" icon="download" href="/cli/installation">
+  Install the Suga CLI on your system to get started
 </Card>

docs/docs.json (1)

43-46: Nav reorg reads well; confirms intro is outside Commands.

No duplication detected with Getting Started. Consider whether “Using the CLI” should be “Overview” to mirror page title, but optional.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5729e4d and 7f231e3.

📒 Files selected for processing (2)

• docs/cli/introduction.mdx (1 hunks)
• docs/docs.json (1 hunks)

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/docs.json (1)

24-24: Add redirect for /cli/installation in docs/docs.json

@@ docs/docs.json
   "navigation": {
@@
     }
   },
+  "redirects": [
+    { "from": "/cli/installation", "to": "/installation" }
+  ],

No occurrences of /cli/installation were found elsewhere; this redirect ensures old links won’t 404.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7f231e3 and 6c26ebd.

📒 Files selected for processing (5)

• docs/cli.mdx (2 hunks)
• docs/docs.json (2 hunks)
• docs/guides.mdx (3 hunks)
• docs/guides/add-suga.mdx (6 hunks)
• docs/quickstart.mdx (12 hunks)

✅ Files skipped from review due to trivial changes (4)

• docs/quickstart.mdx
• docs/guides.mdx
• docs/cli.mdx
• docs/guides/add-suga.mdx

🔇 Additional comments (4)

docs/docs.json (4)

73-73: Rename to “SDK Reference” approved.
Label change is clear and non-breaking for routes.

---

29-35: Guides index exists and all “guides/overview” references removed
docs/guides.mdx is present and no lingering guides/overview links were found.

---

42-65: Ensure CLI docs and intro redirect

Verify that every slug under the “Commands” group in docs/docs.json has a corresponding docs/<slug>.mdx or .md, and add this to the redirects section:

{ "from": "/cli/introduction", "to": "/cli" }

---

77-95: Confirm icon identifiers
Icons are referenced at docs/docs.json lines 81, 86, and 91. Verify your Mintlify theme supports “python”, “node-js”, and “golang” (or update to the correct names).

[nitric-bot]

🎉 This PR is included in version 0.0.6 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀