docs: fix page ToCs, using headings instead of steps

[jyecusch]

No description provided.

[coderabbitai]

📝 Walkthrough

Walkthrough

Refactors multiple documentation guides to replace custom / components with standard Markdown headings, normalize Tip/Info blocks, and reflow code and example sections. Affected guides: add-suga, build-platform, database-migration, local-database-setup, terraform-backend-config. Updates include expanded local database setup (docker-compose, .env, schema/init examples) and restructured Terraform backend guidance. Also adds new accepted vocabulary terms to docs/.vale/styles/config/vocabularies/Suga/accept.txt. No code, public API, or runtime behavior changes.

Possibly related PRs

• Adds install card to CLI introduction and Reorders nav #58: Modifies docs/guides/add-suga.mdx; directly overlaps with this PR’s reformatting of the same guide.
• Backend configuration guide #29: Edits docs/guides/terraform-backend-config.mdx; directly related to the Terraform backend restructuring here.
• docs: add sdk reference pages for node, python, go #54: Updates docs/.vale/styles/config/vocabularies/Suga/accept.txt; related via additions to accepted vocabulary.

Suggested labels

documentation

Suggested reviewers

• tjholm
• HomelessDinosaur
• raksiv
• sean-nitric

Pre-merge checks

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	There is no author-provided description, so reviewers lack context or a summary of the documentation restructuring and heading changes, making the description effectively missing rather than related.	Please add a concise description summarizing the conversion from step-based components to Markdown headings and any other key updates to the guide and vocabulary files.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title clearly summarizes the main change by indicating that documentation pages’ table of contents are being fixed through replacing step components with standard Markdown headings, which matches the primary modifications across multiple guide files.
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 f4e35dc and eb225f3.

📒 Files selected for processing (1)

• docs/guides/add-suga.mdx (1 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: 3

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9a504a1 and 48a132d.

📒 Files selected for processing (5)

• docs/guides/add-suga.mdx (1 hunks)
• docs/guides/build-platform.mdx (1 hunks)
• docs/guides/database-migration.mdx (1 hunks)
• docs/guides/local-database-setup.mdx (1 hunks)
• docs/guides/terraform-backend-config.mdx (1 hunks)

🧰 Additional context used

🧠 Learnings (2)

📚 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/guides/add-suga.mdx

📚 Learning: 2025-08-27T03:55:50.432Z

Learnt from: davemooreuws
PR: nitrictech/suga#29
File: docs/guides/terraform-backend-config.mdx:25-34
Timestamp: 2025-08-27T03:55:50.432Z
Learning: In the Suga project, the default directory for CDKTF synthesized output is `terraform/`, not `cdktf.out/`. The directory structure is terraform/stacks/<stack_name>/ containing the generated Terraform configurations.

Applied to files:

• docs/guides/terraform-backend-config.mdx

🪛 GitHub Actions: Test Docs

docs/guides/add-suga.mdx

[error] 258-258: [Vale.Spelling] Did you really mean 'fmt'?

---

[error] 356-356: [Vale.Spelling] Did you really mean 'gcloud'?

docs/guides/build-platform.mdx

[error] 46-46: [Vale.Spelling] Did you really mean 'VPCs'?

docs/guides/terraform-backend-config.mdx

[error] 68-68: [Vale.Spelling] Did you really mean 'dynamodb_table'?

---

[error] 81-81: [Vale.Spelling] Did you really mean 'gcs'?

---

[error] 96-96: [Vale.Spelling] Did you really mean 'azurerm'?

---

[error] 97-97: [Vale.Spelling] Did you really mean 'resource_group_name'?

---

[error] 98-98: [Vale.Spelling] Did you really mean 'storage_account_name'?

---

[error] 98-98: [Vale.Spelling] Did you really mean 'terraformstatestorage'?

---

[error] 99-99: [Vale.Spelling] Did you really mean 'container_name'?

🪛 GitHub Check: Spell Check with Vale

docs/guides/add-suga.mdx

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

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'gcloud'?", "location": {"path": "docs/guides/add-suga.mdx", "range": {"start": {"line": 356, "column": 5}}}, "severity": "ERROR"}

---

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

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'fmt'?", "location": {"path": "docs/guides/add-suga.mdx", "range": {"start": {"line": 258, "column": 8}}}, "severity": "ERROR"}

docs/guides/terraform-backend-config.mdx

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

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'container_name'?", "location": {"path": "docs/guides/terraform-backend-config.mdx", "range": {"start": {"line": 99, "column": 7}}}, "severity": "ERROR"}

---

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

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'terraformstatestorage'?", "location": {"path": "docs/guides/terraform-backend-config.mdx", "range": {"start": {"line": 98, "column": 31}}}, "severity": "ERROR"}

---

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

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'storage_account_name'?", "location": {"path": "docs/guides/terraform-backend-config.mdx", "range": {"start": {"line": 98, "column": 7}}}, "severity": "ERROR"}

---

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

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'resource_group_name'?", "location": {"path": "docs/guides/terraform-backend-config.mdx", "range": {"start": {"line": 97, "column": 7}}}, "severity": "ERROR"}

---

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

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'azurerm'?", "location": {"path": "docs/guides/terraform-backend-config.mdx", "range": {"start": {"line": 96, "column": 14}}}, "severity": "ERROR"}

---

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

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'gcs'?", "location": {"path": "docs/guides/terraform-backend-config.mdx", "range": {"start": {"line": 81, "column": 14}}}, "severity": "ERROR"}

---

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

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'dynamodb_table'?", "location": {"path": "docs/guides/terraform-backend-config.mdx", "range": {"start": {"line": 68, "column": 7}}}, "severity": "ERROR"}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/.vale/styles/config/vocabularies/Suga/accept.txt (1)

25-34: Vale terms added look good; add a few stragglers to avoid new CI failures.

Nice coverage for backend keys/providers. Please also whitelist:

• s3 (backend name)
• terraform.tfstate (state filename)
• MFA (used in the S3 warning)

This prevents fresh Vale flags from the updated guide.

Apply this minimal diff:

 VPCs
 fmt
 gcloud
 dynamodb_table
 gcs
 azurerm
 resource_group_name
 storage_account_name
 container_name
 tfstatestorage
+s3
+terraform.tfstate
+MFA

docs/guides/terraform-backend-config.mdx (1)

93-104: Optional: make backend key naming consistent across examples.

AWS uses a path-like key (“suga/terraform.tfstate”) while Azure uses a dotted name (“suga.terraform.tfstate”). Consider aligning to one pattern to reduce user confusion.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 48a132d and f4e35dc.

📒 Files selected for processing (2)

• docs/.vale/styles/config/vocabularies/Suga/accept.txt (1 hunks)
• docs/guides/terraform-backend-config.mdx (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-08-27T03:55:50.432Z

Learnt from: davemooreuws
PR: nitrictech/suga#29
File: docs/guides/terraform-backend-config.mdx:25-34
Timestamp: 2025-08-27T03:55:50.432Z
Learning: In the Suga project, the default directory for CDKTF synthesized output is `terraform/`, not `cdktf.out/`. The directory structure is terraform/stacks/<stack_name>/ containing the generated Terraform configurations.

Applied to files:

• docs/guides/terraform-backend-config.mdx

🔇 Additional comments (3)

docs/guides/terraform-backend-config.mdx (3)

41-56: Good switch from Steps to headings; clearer ToC and flow.

Concise restructure; matches Suga’s terraform/ stacks layout.

Based on learnings

---

59-118: Backend examples read well; ensure Vale whitelist matches tokens used.

You’ve introduced/kept tokens like s3, gcs, azurerm, resource_group_name, storage_account_name, container_name, dynamodb_table, tfstatestorage, and “MFA” in prose. Confirm these are whitelisted (s3, terraform.tfstate, MFA were missing before).

---

120-129: Init/apply section is straightforward.

Clear, minimal steps to initialize and deploy.

[nitric-bot]

🎉 This PR is included in version 0.1.25 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀