-
-
Notifications
You must be signed in to change notification settings - Fork 633
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README.md #1671
Update README.md #1671
Conversation
WalkthroughThe pull request involves updating the README.md file for the React on Rails documentation. The primary change is upgrading the version reference from "React on Rails 13" to "React on Rails 14" and expanding the documentation links to include version 13 alongside existing versions 12 and 11. This update reflects the latest release of the software and provides comprehensive version navigation for users. Changes
Poem
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 (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
- GitHub Check: rspec-package-tests (newest)
- GitHub Check: examples (newest)
- GitHub Check: build-dummy-app-webpack-test-bundles (oldest)
- GitHub Check: rspec-package-tests (oldest)
- GitHub Check: build
@@ -23,7 +23,7 @@ | |||
|
|||
----- | |||
|
|||
*These are the docs for React on Rails 13. To see the older docs: [v12](https://github.com/shakacode/react_on_rails/tree/12.6.0) and [v11](https://github.com/shakacode/react_on_rails/tree/11.3.0).* | |||
*These are the docs for React on Rails 14. To see the older docs and code: [v13](https://github.com/shakacode/react_on_rails/tree/13.4.0), [v12](https://github.com/shakacode/react_on_rails/tree/12.6.0), and [v11](https://github.com/shakacode/react_on_rails/tree/11.3.0).* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Codebase verification
The documentation links to specific version tags (13.4.0, 12.6.0, and 11.3.0), but these tags could not be verified in the repository. This may result in broken documentation links.
- Please verify the correct version numbers for v13, v12, and v11 releases
- Update the links to use the correct release tags once confirmed
🔗 Analysis chain
LGTM! Version update looks accurate.
The documentation version has been correctly updated to React on Rails 14, and the version navigation links are properly maintained with specific release tags.
Let's verify that the version tags referenced in the documentation links exist:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that the version tags exist in the repository
# Expected: All version tags should exist and be accessible
for version in "13.4.0" "12.6.0" "11.3.0"; do
echo "Checking tag v$version..."
git rev-parse --verify "refs/tags/$version" 2>/dev/null || echo "Tag $version not found"
done
Length of output: 581
Script:
#!/bin/bash
# Check for tags with 'v' prefix
echo "Checking tags with 'v' prefix..."
for version in "13.4.0" "12.6.0" "11.3.0"; do
echo "Checking tag v$version..."
git rev-parse --verify "refs/tags/v$version" 2>/dev/null || echo "Tag v$version not found"
done
# Use GitHub CLI to verify the refs
echo -e "\nVerifying refs via GitHub API..."
for version in "13.4.0" "12.6.0" "11.3.0"; do
echo "Checking ref $version..."
gh api repos/shakacode/react_on_rails/git/refs/tags/v$version --jq '.ref' 2>/dev/null || echo "Ref not found"
done
Length of output: 1772
Update the version info in README.
This change is
Summary by CodeRabbit