Skip to content

docs: add avoid useNavigate point to AGENTS.md#2300

Merged
reneaaron merged 1 commit into
masterfrom
rolznz-patch-1
May 6, 2026
Merged

docs: add avoid useNavigate point to AGENTS.md#2300
reneaaron merged 1 commit into
masterfrom
rolznz-patch-1

Conversation

@rolznz
Copy link
Copy Markdown
Member

@rolznz rolznz commented May 6, 2026

Summary by CodeRabbit

  • Documentation
    • Updated development guidelines for component usage in React applications.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 6, 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: b8223427-a3a6-45ee-b19b-db2de8ed6ec0

📥 Commits

Reviewing files that changed from the base of the PR and between 12c454f and 3d1de2f.

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

📝 Walkthrough

Walkthrough

A single guideline is added to the TypeScript / React section of AGENTS.md, recommending the use of the <Link/> component over useNavigate for improved browser UX.

Changes

Documentation Guideline Addition

Layer / File(s) Summary
TypeScript / React Guidelines
AGENTS.md
New guideline added: avoid useNavigate and prefer <Link/> component for better browser UX.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • getAlby/hub#2132: Earlier PR that substantially introduced AGENTS.md, which this PR now extends with an additional TypeScript/React guideline.

Poem

🐰 A link, not a hook, is the way to go,
For navigation's grace and browser's flow,
Skip useNavigate's tangled thread,
Let <Link/> guide users ahead!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding a guideline about avoiding useNavigate to AGENTS.md documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch rolznz-patch-1

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.

@reneaaron reneaaron merged commit 21e7b1d into master May 6, 2026
12 checks passed
@reneaaron reneaaron deleted the rolznz-patch-1 branch May 6, 2026 09:01
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.

2 participants