Skip to content

fix(docs): expose library repository in desktop navigation - #1433

Merged
tannerlinsley merged 1 commit into
mainfrom
taren/docs-repository-link
Oct 26, 2026
Merged

tannerlinsley merged 1 commit into
mainfrom
taren/docs-repository-link

Conversation

@tannerlinsley

@tannerlinsley tannerlinsley commented Oct 26, 2026 •

Copy link
Copy Markdown
Member

Docs pages now have a direct GitHub link in the desktop navigation, using each library’s existing repository URL. This makes it easier to move from documentation to source and issues.

Closes #1177.

AI review notes:
pnpm test passed locally. The actual local Query and Router overview pages were inspected at 1280px, with the correct repository destination for each. Compact layouts keep the existing menu link. This has not been deployed yet.

Summary by CodeRabbit

  • New Features
    • Added a link to the library repository on documentation pages. Landing pages retain their existing links.

@changeset-bot

changeset-bot Bot commented Oct 26, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: bc68d71

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.

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

@coderabbitai

coderabbitai Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 44ba5134-f02b-494a-8985-6b5fba30673f
Commits

Reviewing files that changed from the base of the PR and between cd8927e and bc68d71.

Files selected for processing: 1
  • src/components/LibraryLayout.tsx

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Walkthrough

The tabs bar now shows a GitHub link to the library repository on non-landing documentation pages. Landing-page links remain unchanged.

Changes: Library repository link

Layer / File(s) Summary
Show repository link on documentation pages
src/components/LibraryLayout.tsx
The non-landing-page branch now renders a GitHub link with an icon. Landing-page content is unchanged.

Priority: Low

Estimated code review effort: 2 (Simple) | ~5 minutes

Change: Feature · Severity of issue fixed: Low

Suggested reviewers: abeuty, ladybluenotes

Merge Risk: Minimal · up to bc68d

No actionable merge-blocking risk remains.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks: 4 passed
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: adding access to the library repository in desktop documentation navigation.
Linked Issues check Passed Issue #1177 asks for an easy path from library documentation pages to the library repository. The whole-PR diff (merge base cd8927e to head bc68d71) changes only src/components/LibraryLayout.tsx, one …
Out of Scope Changes check Passed The whole-PR diff contains one hunk in src/components/LibraryLayout.tsx. The added GitHub link in the non-landing tabs bar directly implements the issue #1177 objective. No unrelated files or hunks ap…
Full details: Linked Issues check

Explanation

Issue #1177 asks for an easy path from library documentation pages to the library repository. The whole-PR diff (merge base cd8927e to head bc68d71) changes only src/components/LibraryLayout.tsx, one hunk, +11/-1. The former ) : null} branch becomes ) : (...). The new else branch renders an <a href={https://github.com/${repo}`}>` with a GithubIcon and the text 'GitHub' in the tabs bar for non-landing pages. Landing pages keep their existing links. The link opens in a new tab (target=_blank, rel=noreferrer). It uses the existing repo value, so it reuses the library's repository URL. The diff adds no imports or new identifiers, so repo and GithubIcon must already be in scope in this file. The class list hides the link below the xl breakpoint and shows it at xl and above. Compact layouts therefore keep the existing menu link, as the PR description states. This matches the issue's request for desktop documentation pages. The issue does not request automated tests or other non-coding work. The PR reports manual 1280px inspection and a local pnpm test run. Those reports are not independent evidence and were not relied on for this verdict.

Full details: Out of Scope Changes check

Explanation

The whole-PR diff contains one hunk in src/components/LibraryLayout.tsx. The added GitHub link in the non-landing tabs bar directly implements the issue #1177 objective. No unrelated files or hunks appear in the reviewed changes. The raw summary reports the same single-file change (+11/-1) and no declaration changes. No out-of-scope change was found.

Finishing Touches: 💡 1
📝 Generate docstrings: 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
tanstack-com bc68d71 Commit Preview URL

Branch Preview URL
Oct 26 2026, 07:32 PM

@tannerlinsley
tannerlinsley merged commit 37e758f into main Oct 26, 2026
8 checks passed
@tannerlinsley
tannerlinsley deleted the taren/docs-repository-link branch October 26, 2026 19:40
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.

Difficult to get to the library repo from the docs pages

1 participant