docs: README typo fixes

[oycyc]

/examples/complete/root-modules/spacelift-automation/tfvars/example.tfvars doesn't exist. Point at the examples/complete/root-modules/spacelift-automation root module example.

Summary by CodeRabbit

• Documentation
  • Updated the Usage section link to reference the full example directory rather than a single file, improving discoverability of the complete setup and reducing confusion.
  • Polished wording in the Remote stacks guidance for clarity; example content remains unchanged.
  • No functional or API changes; documentation-only update.

[coderabbitai]

Walkthrough

README.md was updated to change a Usage section example link from tfvars/example.tfvars to the directory examples/complete/root-modules/spacelift-automation. A minor grammar correction was made in the Remote stacks guidance sentence (“here's how it might look …”); code block content stayed the same.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• feat: first pass at reworking to more holistic example infra-monorepo-template#5 — Adjusts README example references and paths, similar documentation scope.
• chore: sync with template terraform-spacelift-policies#11 — README edits overlapping on Usage/example wording.

Suggested reviewers

• Gowiem

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title succinctly indicates that the pull request updates the README and addresses typographical and documentation issues, which aligns with the changes made to the example link and grammar in the file.
Description Check	✅ Passed	The description directly explains the problem with the broken example file path and the updated reference to the correct module directory, clearly relating to the changes in the README.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
		  - name: "Undocumented Breaking Changes"
			  mode: "warning"
			  instructions: |
				  Flag potential breaking changes that are not documented:
				  1. Identify changes to public APIs/exports, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints (including removed/renamed items and changes to types, required params, return values, defaults, or behavior).
				  2. Ignore purely internal/private changes (e.g., code not exported from package entry points or marked internal).
				  3. Verify documentation exists: a "Breaking Change" section in the PR description and updates to CHANGELOG.md.

Please share your feedback with us on this Discord post.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/typos-fixes

---

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)

README.md (2)

101-101: Minor typo: “directrory” → “directory”.

Apply:

-101
-- Stacks track changes in GitHub repo `github.com/masterpointio/terraform-spacelift-automation`, branch `main` (the default), and directrory `root-modules`.
+101
+- Stacks track changes in GitHub repo `github.com/masterpointio/terraform-spacelift-automation`, branch `main` (the default), and directory `root-modules`.

---

190-190: Link directly to a concrete example file
The directory examples/complete/root-modules/spacelift-automation exists and contains main.tf. Update the reference to point to examples/complete/root-modules/spacelift-automation/main.tf for quicker navigation.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3fce25e and 05540dd.

📒 Files selected for processing (1)

• README.md (2 hunks)

🔇 Additional comments (1)

README.md (1)

248-248: Grammar tweak LGTM.
Change from “now” to “how” reads correctly.

[Gowiem]

Don't worry about merging the release please -- we should let it sit until a real release is ready.