Docs/more badges #678
Docs/more badges #678
Conversation
WalkthroughThe pull request introduces documentation enhancements to the Changes
Suggested Reviewers
Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
41-41: Remove trailing spaces in badge image tagsThere are trailing spaces after the badge image tags on lines 41, 77, 115, and 155. While they don't affect rendering, they should be removed for cleaner markdown.
- <img alt="crates" src="https://img.shields.io/crates/v/axone-objectarium.svg?style=for-the-badge&color=orange"/> + <img alt="crates" src="https://img.shields.io/crates/v/axone-objectarium.svg?style=for-the-badge&color=orange"/>Also applies to: 77-77, 115-115, 155-155
🧰 Tools
🪛 Markdownlint (0.37.0)
41-41: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(5 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
README.md
41-41: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
77-77: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
115-115: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
155-155: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
🔇 Additional comments (3)
README.md (3)
9-10: LGTM: Appropriate addition of cargo-make badge
The new badge aligns well with the build tools section and provides a helpful link to the cargo-make documentation.
35-42: LGTM: Consistent badge and link additions across contracts
The changes systematically add crates.io links and badges for all contracts while maintaining visual consistency. This enhancement improves the documentation by providing direct access to package information.
Also applies to: 71-78, 109-116, 149-156
🧰 Tools
🪛 Markdownlint (0.37.0)
41-41: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
41-41: Verify crate version badges are up-to-date
Let's ensure the version badges reflect the latest published versions on crates.io.
Also applies to: 77-77, 115-115, 155-155
✅ Verification successful
Let me check the actual badge versions in the README to compare with the crates.io versions.
Version badges are dynamically updated and accurate
The version badges in the README are using dynamic shields.io URLs that automatically fetch and display the latest versions from crates.io. All four crates (axone-objectarium, axone-cognitarium, axone-law-stone, and axone-dataverse) are correctly configured to show their current versions (7.0.0) without hardcoding the version numbers in the URLs.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that the crate versions in badges match the latest published versions
echo "Checking latest versions for axone crates..."
for crate in axone-objectarium axone-cognitarium axone-law-stone axone-dataverse; do
echo "Checking $crate..."
curl -s "https://crates.io/api/v1/crates/$crate" | jq -r '.crate.max_version'
done
Length of output: 1066
Script:
#!/bin/bash
# Get the badge URLs from README.md to extract versions
cat README.md | grep -E "img.shields.io/crates/v/axone-.*\.svg"
Length of output: 549
🧰 Tools
🪛 Markdownlint (0.37.0)
41-41: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
ccamel
force-pushed
the
docs/more-badges
branch
from
7a99ce7 to
2bdc24e
Compare
size-limit report 📦
|
Codecov ReportAll modified and coverable lines are covered by tests ✅ |
Simple:
cargo-maketo the build section.axone-objectarium,axone-cognitarium,axone-law-stoneandaxone-dataversecrates (thanks to Ci/publish #672).Summary by CodeRabbit
cargo-make.crates.ioforaxone-objectarium,axone-cognitarium,axone-law-stone, andaxone-dataversecontracts.