Skip to content

Closes #108: Docs: update stale version references and consistently code-format examples - #109

Merged
charlesgreen merged 1 commit into
mainfrom
sc/108
Aug 1, 2026
Merged

charlesgreen merged 1 commit into
mainfrom
sc/108

Conversation

@simplycubed-code

Copy link
Copy Markdown
Contributor

Automated change from an issue. A human reviews and merges; this loop does not.

Walkthrough

This docs-only change audits the user-facing install and release guidance to remove stale version references and align the docs on the current v0.1.9 release. The install examples in the README, setup guide, and status page now treat the version as a pinned <release-tag> to reduce repeated hardcoded tags, while still calling out v0.1.9 as the current known release and showing the matching simplycubed version output.

It also makes the command examples more consistent and easier to scan. Inline CLI invocations that describe operational checks now appear as fenced shell blocks where appropriate, and the surrounding prose more clearly explains what preflight, --dry-run, and model override commands do. The release-process doc is updated in the same spirit by replacing version-specific examples with reusable semver placeholders and timeless wording.

Changes

Area Summary
Top-level product docs README.md and STATUS.md refresh the current release messaging, replace hardcoded install tags with <release-tag>, and keep version/output examples consistent with v0.1.9.
Setup and operator guidance docs/setup.md updates onboarding snippets to use a pinned placeholder tag and reformats operational CLI examples like preflight, --dry-run, and --model into clearer shell blocks.
Release process docs docs/release.md removes stale point-release examples in favor of generic vX.Y.Z and <tag> placeholders so release instructions stay accurate across future versions.

Generated description — verify against the diff.

🤖 Generated with SimplyCubed Code

…ode-format examples

Co-Authored-By: SimplyCubed Code <noreply@simplycubed.com>
@codecov

codecov Bot commented Aug 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@charlesgreen
charlesgreen merged commit bf37758 into main Aug 1, 2026
3 checks passed
@charlesgreen
charlesgreen deleted the sc/108 branch August 1, 2026 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant