fix(docs): exclude unlisted category links from DocBreadcrumbs structured data

[akshatsinha0]

Pre-flight checklist

• I have read the Contributing Guidelines on pull requests.
• If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
• If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

When a docs category has an unlisted generated-index page (linkUnlisted: true), its href is kept on the sidebar item intentionally so the active sidebar highlight still works. That href was leaking into the DocBreadcrumbs JSON-LD structured data and being emitted to Googlebot even though the link is invisible to human visitors.

The suppression in DocBreadcrumbs/index.tsx only applies to the rendered <a> element:

// DocBreadcrumbs/index.tsx
const href =
  item.type === 'category' && item.linkUnlisted
    ? undefined
    : item.href;

This does not mutate the breadcrumbs array. The raw array is passed unchanged to <DocBreadcrumbsStructuredData breadcrumbs={breadcrumbs} />, so structuredDataUtils.ts receives the item with href set and the existing .filter((b) => b.href) passes it through. The result is a BreadcrumbList ListItem pointing at an unlisted URL in the page's <script type="application/ld+json">.

Fix: extend the filter in structuredDataUtils.ts to also exclude category items where linkUnlisted is true:

.filter(
  (breadcrumb) =>
    breadcrumb.href &&
    !(breadcrumb.type === 'category' && breadcrumb.linkUnlisted),
)

Test Plan

Unit tests added in packages/docusaurus-plugin-content-docs/src/client/__tests__/structuredDataUtils.test.tsx (AI assistance was taken here):

• Verifies breadcrumbs with href are included in itemListElement.
• Verifies breadcrumbs without href are excluded.
• Verifies a category with linkUnlisted: true and a non-null href is excluded from itemListElement.
• Verifies a category with linkUnlisted: false and a non-null href is included normally.

Run: yarn test packages/docusaurus-plugin-content-docs/src/client/__tests__/structuredDataUtils.test.tsx

Test links

Deploy preview: https://deploy-preview-11842--docusaurus-2.netlify.app/

Related issues/PRs

No related issues found.

[netlify]

✅ [V2]

Built without sensitive environment variables

Name	Link
🔨 Latest commit	dbe5ae1
🔍 Latest deploy log	https://app.netlify.com/projects/docusaurus-2/deploys/69c4f6b1c1c8370008b08d30
😎 Deploy Preview	https://deploy-preview-11842--docusaurus-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.