Skip to content

fix: omit docs version folders from autolink titles - #2374

Open
Ibochkarev wants to merge 1 commit into
nuxt:mainfrom
Ibochkarev:fix/issue-2163-filter-docs-version-autolink
Open

fix: omit docs version folders from autolink titles#2374
Ibochkarev wants to merge 1 commit into
nuxt:mainfrom
Ibochkarev:fix/issue-2163-filter-docs-version-autolink

Conversation

@Ibochkarev

Copy link
Copy Markdown
Contributor

🔗 Linked issue

Fixes #2163

📚 Description

LinkExample titles turned path segments like 4.x into 4 X, so live-example callouts read Docs > 4 X > Examples….

I skipped N.x folders in createBreadcrumb, pointed ReadMore at the same helper, and added a unit test for the state-management example path.

@vercel

vercel Bot commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

@Ibochkarev is attempting to deploy a commit to the Nuxt Team on Vercel.

A member of the Team first needs to authorize it.

@Ibochkarev
Ibochkarev marked this pull request as ready for review August 9, 2026 01:50
@Ibochkarev
Ibochkarev requested a review from atinux as a code owner August 9, 2026 01:50
@coderabbitai

coderabbitai Bot commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: ed4c8c04-772d-4680-a873-28039dd93818

📥 Commits

Reviewing files that changed from the base of the PR and between 29e59bb and 50cdbbd.

📒 Files selected for processing (3)
  • app/components/content/ReadMore.vue
  • app/utils/index.ts
  • test/nuxt/index.spec.ts
💤 Files with no reviewable changes (1)
  • app/components/content/ReadMore.vue

📝 Walkthrough

Walkthrough

The shared createBreadcrumb utility now removes documentation version folders such as 4.x and 3.x before formatting titles. ReadMore.vue removes its local breadcrumb helper and unused imports, but computedTitle still references createBreadcrumb. Tests cover version-folder omission while preserving surrounding breadcrumb sections.

Estimated code review effort: 3 (Moderate) | ~20 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The PR filters version folders in createBreadcrumb, but ReadMore still references the removed helper and may not build. Update ReadMore to use the shared createBreadcrumb helper and verify that the project builds and tests pass.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes omitting documentation version folders from autolink titles.
Description check ✅ Passed The description explains the version-folder filtering, shared breadcrumb logic, and added test.
Out of Scope Changes check ✅ Passed The changes are limited to breadcrumb generation, ReadMore integration, and a related unit test.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 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.

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.

Filter out versions in autolink titles in docs

1 participant