Closes #108: Docs: update stale version references and consistently code-format examples - #109
Merged
Merged
Conversation
…ode-format examples Co-Authored-By: SimplyCubed Code <noreply@simplycubed.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
8 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.9release. 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 outv0.1.9as the current known release and showing the matchingsimplycubed versionoutput.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
<release-tag>, and keep version/output examples consistent withv0.1.9.preflight,--dry-run, and--modelinto clearer shell blocks.vX.Y.Zand<tag>placeholders so release instructions stay accurate across future versions.Generated description — verify against the diff.
🤖 Generated with SimplyCubed Code