Skip to content

docs: fix Preact hydration nav link#10274

Open
DeoJin wants to merge 1 commit intoTanStack:mainfrom
DeoJin:fix-community-resources-github-link
Open

docs: fix Preact hydration nav link#10274
DeoJin wants to merge 1 commit intoTanStack:mainfrom
DeoJin:fix-community-resources-github-link

Conversation

@DeoJin
Copy link

@DeoJin DeoJin commented Mar 16, 2026

Summary

  • fix the Preact API reference hydration nav entry in docs/config.json
  • point it to ramework/preact/reference/functions/HydrationBoundary, which exists in this repo
  • avoid the current broken link to the non-existent React path

Validation

  • Get-Content 'docs/config.json' -Raw | ConvertFrom-Json
  • verified docs/framework/preact/reference/functions/HydrationBoundary.md exists
  • git diff --check

Notes

This is a small docs/navigation fix discovered while investigating docs link issues.

Summary by CodeRabbit

  • Documentation
    • Corrected API reference documentation to ensure HydrationBoundary references point to the appropriate framework implementation across both React and Preact documentation sections.

@changeset-bot
Copy link

changeset-bot bot commented Mar 16, 2026

⚠️ No Changeset found

Latest commit: 2d6efe9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 16, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 16, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9113c07f-f205-4abd-9e8c-2fed0f531635

📥 Commits

Reviewing files that changed from the base of the PR and between d4fd941 and 2d6efe9.

📒 Files selected for processing (1)
  • docs/config.json

📝 Walkthrough

Walkthrough

Updated configuration file to redirect HydrationBoundary API reference targets from React framework context to Preact framework context in both React and Preact API reference sections. Configuration strings modified to reflect the new reference paths.

Changes

Cohort / File(s) Summary
Configuration Updates
docs/config.json
Updated HydrationBoundary API reference targets to point from React framework to Preact framework context in both React and Preact framework API reference sections.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~5 minutes

Poem

🐰 A hop through config files so bright,
From React's path to Preact's light,
HydrationBoundary takes its place,
References updated with grace! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is mostly complete with clear summary and validation steps, but does not follow the provided template structure with required sections like 'Changes', 'Checklist', and 'Release Impact'. Reformat the description to match the repository template with sections for Changes, Checklist, and Release Impact to ensure consistency.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: fixing a Preact hydration navigation link in the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

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.

Tip

CodeRabbit can use TruffleHog to scan for secrets in your code with verification capabilities.

Add a TruffleHog config file (e.g. trufflehog-config.yml, trufflehog.yml) to your project to customize detectors and scanning behavior. The tool runs only when a config file is present.

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant