-
-
Notifications
You must be signed in to change notification settings - Fork 634
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
chore: make docs MDX-compatible, pt. 2 #1725
Conversation
WalkthroughThe Turbolinks documentation for Rails has been updated to clarify the versioning language regarding React on Rails compatibility. The sentence has been modified from stating "React on Rails <15" to "React on Rails earlier than 15." There are no changes to functionality or logic, only a clarification in wording. Changes
Poem
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. 🪧 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: 0
🧹 Nitpick comments (2)
docs/rails/turbolinks.md (2)
87-92
: Clarify Version Compatibility WordingThe updated sentence now reads “React on Rails earlier than 15,” which is clearer and more descriptive compared to using the symbolic "<15." This improves readability and reduces ambiguity for documentation readers. Please verify that any other references to the version are updated similarly for consistency.
1-1
: Ensure MDX CompatibilityWhile the changes here focus on clarifying version compatibility, please double-check that the Markdown syntax used in this file aligns with MDX expectations in your Gatsby configuration. For instance, if additional front matter or JSX components will be added later to enhance MDX features, ensure that the file structure can accommodate those without conflicts.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/rails/turbolinks.md
(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: dummy-app-integration-tests (oldest)
- GitHub Check: dummy-app-integration-tests (newest)
Summary
Followup to #1724 - I missed a file. Same intent: to make the
.md
files insidedocs/
parseable as MDX so Gatsby can pull them in and build properly.This change is
Summary by CodeRabbit