Skip to content

fix(docs): link shared architecture/resources at root, not /python#275

Merged
pratyush618 merged 1 commit into
masterfrom
fix/docs-shared-nav-links
Jun 21, 2026
Merged

fix(docs): link shared architecture/resources at root, not /python#275
pratyush618 merged 1 commit into
masterfrom
fix/docs-shared-nav-links

Conversation

@pratyush618

@pratyush618 pratyush618 commented Jun 21, 2026

Copy link
Copy Markdown
Collaborator

Problem

Nav, footer, and the landing "comparison" CTA linked architecture/changelog/FAQ/comparison under /python/*. Those /python/* paths only exist as redirect stubs (real content lives at the shared root /architecture, /resources/*), so every click bounced through a redirect to a bare-root URL — reported as architecture → /architecture, changelog → /resources/changelog.

Why root is correct

Architecture and resources (changelog/FAQ/comparison) are SDK-agnostic — they apply to both the Python and Node SDKs, so they live at shared root paths, not under /python/. This matches how multi-SDK docs (e.g. Temporal) separate language-independent concepts from per-language guides.

Fix

Point the nav/footer/CTA links directly at the canonical shared root URLs — no redirect hop. app/lib/redirects.ts keeps mapping old /python/* deep links to root for external bookmarks.

  • site-nav.tsx: Architecture → /architecture, Changelog → /resources/changelog
  • footer.tsx: Architecture → /architecture; comparison/FAQ/changelog → /resources/*
  • sections.tsx: comparison CTA → /resources/comparison

Per-SDK links (getting-started, guides, API, examples) stay /python/* unchanged.

Verify

  • pnpm typecheck + pnpm build + pnpm lint green.

Summary by CodeRabbit

  • Chores
    • Reorganized navigation links across the site. Updated paths for comparison, FAQ, changelog, and architecture documentation resources to streamline navigation structure and improve overall site information accessibility.

Nav, footer, and the comparison CTA pointed at /python/* paths that only exist as redirect stubs, so every click bounced to the real shared page. Architecture and resources are SDK-agnostic (Python + Node), so link their canonical root URLs directly.
@github-actions github-actions Bot added the docs label Jun 21, 2026
@coderabbitai

coderabbitai Bot commented Jun 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d84c94d8-0966-4acb-bab3-1fa2005b0d62

📥 Commits

Reviewing files that changed from the base of the PR and between 50fbcbc and 09332aa.

📒 Files selected for processing (3)
  • docs/app/components/landing/footer.tsx
  • docs/app/components/landing/sections.tsx
  • docs/app/components/ui/site-nav.tsx

📝 Walkthrough

Walkthrough

Three documentation app navigation files update link href values: footer "More" section links for Celery comparison, FAQ, and Changelog move from /python/more/* to /resources/*; the site nav updates Architecture from /python/architecture to /architecture and Changelog from /python/more/changelog to /resources/changelog; and the landing CTA updates the comparison link to /resources/comparison.

Changes

Navigation URL Path Updates

Layer / File(s) Summary
Updated navigation hrefs across footer, site-nav, and CTA
docs/app/components/ui/site-nav.tsx, docs/app/components/landing/footer.tsx, docs/app/components/landing/sections.tsx
LINKS in site-nav.tsx changes Architecture to /architecture and Changelog to /resources/changelog; COLS in footer.tsx updates three More-section entries to /resources/*; the CTA component in sections.tsx updates the comparison link to /resources/comparison.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 Hop, hop, the paths have changed,
No more /python/more arranged!
/resources is where we land,
With architecture close at hand.
The bunny updates links with glee —
Clean URLs for all to see! 🌿

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ 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%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ 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 'fix(docs): link shared architecture/resources at root, not /python' accurately summarizes the main change: updating navigation links to point to root URLs for shared content instead of language-specific /python paths.
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 docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/docs-shared-nav-links

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

@pratyush618
pratyush618 merged commit c21a0a6 into master Jun 21, 2026
18 checks passed
@pratyush618
pratyush618 deleted the fix/docs-shared-nav-links branch June 21, 2026 06:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant