docs(repo): fix broken RELEASE.md and example migration links - #2582
Merged
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughSummary by CodeRabbit
WalkthroughUpdated 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 |
mandarini
approved these changes
Jul 31, 2026
Contributor
|
Thanks |
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
2 participants
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.
While reading the docs I noticed two relative markdown links that point at paths which do not exist. CONTRIBUTING.md linked to ./RELEASE.md, but the file lives at docs/RELEASE.md, and the realtime-js example README linked to the SQL migration using a repository-root path instead of one relative to that README. I corrected both targets so they resolve on GitHub and in local editors.
I left the ./docs/SECURITY.md link in README.md alone: that file is not present anywhere in the repository, and I did not want to guess whether it should point at an org-level policy or a file still to be added. Worth noting AGENTS.md has the same broken link, so a maintainer may want to decide on both together.
I pushed this to my fork first and the project's own CI workflows pass on the commit.