Skip to content

docs: Fix generated API readme anchors#10460

Open
jacog2 wants to merge 1 commit into
parse-community:alphafrom
jacog2:codex-fix-api-readme-anchors
Open

docs: Fix generated API readme anchors#10460
jacog2 wants to merge 1 commit into
parse-community:alphafrom
jacog2:codex-fix-api-readme-anchors

Conversation

@jacog2
Copy link
Copy Markdown

@jacog2 jacog2 commented May 11, 2026

What changed

  • Add explicit README anchor aliases for the GitHub-style hashes used by the table of contents.
  • Keeps the current headings unchanged while making the generated JSDoc API homepage resolve those hashes.

Why

The generated API page creates heading IDs such as flavors-%26-branches, node.js, and parse-server-%2B-express, while the README table of contents links to flavors--branches, nodejs, and parse-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 docs
  • Verified generated out/index.html has missing_hash_targets=0 for unique same-page hash links
  • git diff --check

Summary by CodeRabbit

  • Documentation
    • Improved README navigation through the addition of anchor links for key sections, including Flavors & Branches, Node.js compatibility information, Parse Server + Express integration details, and GraphQL Express usage guides. These anchors enable better table-of-contents support and allow users to quickly jump to relevant documentation sections.

Review Change Stack

@parse-github-assistant
Copy link
Copy Markdown

I will reformat the title to use the proper commit message syntax.

@parse-github-assistant parse-github-assistant Bot changed the title docs: fix generated API readme anchors docs: Fix generated API readme anchors May 11, 2026
@parse-github-assistant
Copy link
Copy Markdown

🚀 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

  • Keep pull requests small. Large PRs will be rejected. Break complex features into smaller, incremental PRs.
  • Use Test Driven Development. Write failing tests before implementing functionality. Ensure tests pass.
  • Group code into logical blocks. Add a short comment before each block to explain its purpose.
  • We offer conceptual guidance. Coding is up to you. PRs must be merge-ready for human review.
  • Our review focuses on concept, not quality. PRs with code issues will be rejected. Use an AI agent.
  • Human review time is precious. Avoid review ping-pong. Inspect and test your AI-generated code.

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.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 11, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c5612df6-6538-4579-8015-77c77908fb93

📥 Commits

Reviewing files that changed from the base of the PR and between 4f90c5e and b215982.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The 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.

Changes

Documentation Navigation Anchors

Layer / File(s) Summary
Navigation Anchor Tags
README.md
HTML anchor tags with id attributes are added to four section headings: "Flavors & Branches" (line 102–103), "Node.js" (line 131–132), "Parse Server + Express" (line 228–229), and "Using Express.js" (line 990–991). These anchors enable browser navigation when table-of-contents links reference these section hashes.

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 6 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Engage In Review Feedback ❓ Inconclusive Cannot assess review feedback. One commit with no follow-ups. GitHub PR comments not accessible in local git repository. Access GitHub PR #10460 to verify all review comments and engagement before conclusion.
✅ Passed checks (6 passed)
Check name Status Explanation
Title check ✅ Passed The title begins with the 'docs:' prefix as required and clearly describes the change: fixing generated API readme anchors.
Description check ✅ Passed The description includes a clear explanation of what changed, why it was changed, and validation steps performed, meeting the repository's documentation requirements.
Linked Issues check ✅ Passed The PR directly addresses issue #889 by adding explicit HTML anchor tags to section headings, enabling the generated API page to resolve table-of-contents hash links correctly.
Out of Scope Changes check ✅ Passed All changes are limited to adding HTML anchor aliases in the README to fix broken navigation links, with no unrelated modifications introduced.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Security Check ✅ Passed No security vulnerabilities. The PR adds 4 safe HTML anchors to README.md with valid ID attributes only. No XSS, injection, or code execution patterns detected.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

🐛 Navigation links in the API page are broken

1 participant