Fix Markdown comment syntax in docs source files#11010
Open
nduaarte wants to merge 1 commit into
Open
Conversation
Contributor
📝 WalkthroughWalkthroughThis PR standardizes Markdown comment marker syntax used for snippet referencing across docs/framework and docs/reference, switching from a single-quoted form (e.g., ChangesDocumentation marker syntax and content updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~20 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/framework/react/guides/prefetching.md (1)
417-438: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueOptionally hyphenate "Server Side" as compound adjective.
Line 436 uses "Server Side routers" which could be hyphenated as "Server-Side routers" for grammatical precision. This is a minor style preference.
🤖 Prompt for 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. In `@docs/framework/react/guides/prefetching.md` around lines 417 - 438, Update the wording in the prefetching guide to optionally hyphenate the compound adjective in the sentence about routers and frameworks. In the “Further reading” section of the Markdown doc, adjust the phrase used in the sentence near the Server Rendering & Hydration link so it reads as “Server-Side routers” instead of “Server Side routers,” keeping the rest of the text unchanged.
🤖 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.
Nitpick comments:
In `@docs/framework/react/guides/prefetching.md`:
- Around line 417-438: Update the wording in the prefetching guide to optionally
hyphenate the compound adjective in the sentence about routers and frameworks.
In the “Further reading” section of the Markdown doc, adjust the phrase used in
the sentence near the Server Rendering & Hydration link so it reads as
“Server-Side routers” instead of “Server Side routers,” keeping the rest of the
text unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: f55e8356-266a-401d-9bca-9a7550952cb9
📒 Files selected for processing (40)
docs/framework/angular/guides/query-cancellation.mddocs/framework/angular/overview.mddocs/framework/angular/quick-start.mddocs/framework/react/graphql.mddocs/framework/react/guides/advanced-ssr.mddocs/framework/react/guides/background-fetching-indicators.mddocs/framework/react/guides/default-query-function.mddocs/framework/react/guides/dependent-queries.mddocs/framework/react/guides/disabling-queries.mddocs/framework/react/guides/important-defaults.mddocs/framework/react/guides/infinite-queries.mddocs/framework/react/guides/initial-query-data.mddocs/framework/react/guides/invalidations-from-mutations.mddocs/framework/react/guides/migrating-to-v5.mddocs/framework/react/guides/mutations.mddocs/framework/react/guides/optimistic-updates.mddocs/framework/react/guides/paginated-queries.mddocs/framework/react/guides/parallel-queries.mddocs/framework/react/guides/placeholder-query-data.mddocs/framework/react/guides/polling.mddocs/framework/react/guides/prefetching.mddocs/framework/react/guides/queries.mddocs/framework/react/guides/query-cancellation.mddocs/framework/react/guides/query-functions.mddocs/framework/react/guides/query-invalidation.mddocs/framework/react/guides/query-keys.mddocs/framework/react/guides/query-options.mddocs/framework/react/guides/query-retries.mddocs/framework/react/guides/request-waterfalls.mddocs/framework/react/guides/updates-from-mutation-responses.mddocs/framework/react/guides/window-focus-refetching.mddocs/framework/react/installation.mddocs/framework/react/overview.mddocs/framework/react/quick-start.mddocs/framework/react/reference/hydration.mddocs/framework/react/reference/queryOptions.mddocs/framework/react/typescript.mddocs/framework/solid/typescript.mddocs/framework/vue/guides/prefetching.mddocs/reference/QueryCache.md
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
1 participant
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.
🎯 Changes
Fixes visible
[//]: # 'Example'markers appearing literally in therendered documentation (e.g. on the Queries guide page).
The intended Markdown "hidden comment" syntax requires parentheses, not
quotes:
The docs were using single quotes instead:
This is not recognized as a hidden link-reference by Markdown parsers, so
the marker renders visibly on the page instead of being hidden.
Root cause: most framework-specific docs (Vue, Angular, Solid, Svelte)
are generated from the
react/source files viascripts/generate-docs.ts.The malformed syntax originated in the
react/source and was propagatedto every generated file.
Fix: updated the syntax only in the 38 source files that do not have a
ref:frontmatter field (i.e. the files that are not auto-generated).Running
pnpm generate-docswill propagate this fix to the remaininggenerated files automatically.
Confirmed no project code references the old pattern:
(no matches found)
Note: was unable to run
pnpm run test:prlocally due to unstable networkconditions while installing dependencies. Verified the change manually via
seddry-runs andgit diff --stat(38 files changed, 1:1 linereplacement, no unintended additions/removals).
✅ Checklist
pnpm run test:pr.🚀 Release Impact
Summary by CodeRabbit