Skip to content

docs: add version badge to zcp cli - #48

Open
cokerrd wants to merge 3 commits into
zsoftly:mainfrom
cokerrd:docs/add-version-badge
Open

docs: add version badge to zcp cli #48
cokerrd wants to merge 3 commits into
zsoftly:mainfrom
cokerrd:docs/add-version-badge

Conversation

@cokerrd

@cokerrd cokerrd commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

What changed

  • Replaced static version number for zcp cli docs with dynamic shields.io badge
  • Badge automatically pulls latest release tag from GitHub

Why

Static version number on the zcp cli docs become outdated quickly (e.g. the official docs still show v0.0.15 while the latest is v0.0.23). With the dynamic badge, maintainers no longer need to manually update the version for each release, and the badge always reflects the current release automatically.

Before

Screenshot 2026-07-15 at 00 00 06

After

Screenshot 2026-07-15 at 00 00 30

Summary by CodeRabbit

  • Documentation
    • Updated the CLI installation guide to show the current version dynamically using a GitHub releases badge (instead of a fixed version string).

@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cdf8cd48-3686-44f8-818f-47115807ef34

📥 Commits

Reviewing files that changed from the base of the PR and between 7d46b57 and 54debb3.

📒 Files selected for processing (1)
  • src/content/docs/public-cloud/cli/installation.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/content/docs/public-cloud/cli/installation.md

📝 Walkthrough

Walkthrough

The CLI installation documentation replaces its static current version value with a dynamic GitHub releases badge and reformats the GitHub URL.

Changes

CLI version display

Layer / File(s) Summary
Replace static CLI version
src/content/docs/public-cloud/cli/installation.md
The “Current version” line now renders a GitHub releases version badge, and the GitHub reference is formatted as a standalone URL.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: ditahm6, ditahkk, godsonten, clintonche

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly reflects the main change: adding a version badge to the ZCP CLI docs.
Description check ✅ Passed The description includes the required What changed and Why sections and explains the motivation clearly.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/content/docs/public-cloud/cli/installation.md`:
- Around line 11-12: Update the current-version badge markup so it exposes the
release version to assistive technologies instead of using an empty alt value.
Add an accurate textual fallback or adjacent dynamically rendered version text
while preserving the existing visual badge.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ebb01e6d-8ea9-4096-92bd-58d2d9c6c951

📥 Commits

Reviewing files that changed from the base of the PR and between 76e5d35 and 7d46b57.

📒 Files selected for processing (1)
  • src/content/docs/public-cloud/cli/installation.md

Comment thread src/content/docs/public-cloud/cli/installation.md Outdated
@ditahkk

ditahkk commented Jul 22, 2026

Copy link
Copy Markdown
Member

@cokerrd Thanks for your contributions on this, your commits have been merged and deployed to dev and we are doing testing and reviews. I belive once you resolve the commits, it will auto merge on your side

cokerrd pushed a commit to cokerrd/zcp-docs that referenced this pull request Jul 22, 2026
… SSH keygen guides

Builds on the version-badge idea from @cokerrd (zsoftly#48):
- installation: give the badge real alt text and wrap it in a link to
  releases/latest; allow img.shields.io in the production CSP (img-src) so the
  badge actually renders in prod instead of being blocked
- object-storage: add an s3cmd config and command reference to S3 API Usage
- compute: add an SSH key generation section to Connect With SSH
@cokerrd

cokerrd commented Jul 22, 2026

Copy link
Copy Markdown
Contributor Author

@cokerrd Thanks for your contributions on this, your commits have been merged and deployed to dev and we are doing testing and reviews. I belive once you resolve the commits, it will auto merge on your side

nice, thanks! just resolved the merge conflict @ditahkk

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.

2 participants