docs: Fix generated API readme anchors#10460
Conversation
|
I will reformat the title to use the proper commit message syntax. |
|
🚀 Thanks for opening this pull request! We appreciate your effort in improving the project. Please let us know once your pull request is ready for review. Tip
Note Please respond to review comments from AI agents just like you would to comments from a human reviewer. Let the reviewer resolve their own comments, unless they have reviewed and accepted your commit, or agreed with your explanation for why the feedback was incorrect. Caution Pull requests must be written using an AI agent with human supervision. Pull requests written entirely by a human will likely be rejected, because of lower code quality, higher review effort and the higher risk of introducing bugs. Please note that AI review comments on this pull request alone do not satisfy this requirement. Our CI and AI review are safeguards, not development tools. If many issues are flagged, rethink your development approach. Invest more effort in planning and design rather than using review cycles to fix low-quality code. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe PR adds HTML anchor tags to four section headings in README.md to support table-of-contents navigation. Anchors are inserted before the "Flavors & Branches", "Node.js", "Parse Server + Express", and "Using Express.js" sections to enable direct page scrolling when navigation links reference these sections. ChangesDocumentation Navigation Anchors
🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 6 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (6 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
What changed
Why
The generated API page creates heading IDs such as
flavors-%26-branches,node.js, andparse-server-%2B-express, while the README table of contents links toflavors--branches,nodejs, andparse-server--express. Those links changed the hash without landing on a target.Closes parse-community/docs#889
Validation
npm.cmd ci(passes; local Node v25.9.0 is outside the repo engine range, so npm prints EBADENGINE warnings).\node_modules\.bin\babel.cmd src\ -d lib\ --copy-files --extensions .ts,.js(Windows-local build workaround; package script quotes make Babel compile 0 files in PowerShell)npm.cmd run docsout/index.htmlhasmissing_hash_targets=0for unique same-page hash linksgit diff --checkSummary by CodeRabbit