docs: add version badge to zcp cli - #48
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe CLI installation documentation replaces its static current version value with a dynamic GitHub releases badge and reformats the GitHub URL. ChangesCLI version display
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (1)
src/content/docs/public-cloud/cli/installation.md
|
@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 |
… 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
What changed
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
After
Summary by CodeRabbit