Skip to content

docs: update broken links and reference anchors in plugin documentation - #12785

Open
Hrushikesh-ramilla wants to merge 1 commit into
meta:mainfrom
Hrushikesh-ramilla:docs/plugin-broken-links
Open

Hrushikesh-ramilla wants to merge 1 commit into
meta:mainfrom
Hrushikesh-ramilla:docs/plugin-broken-links

Conversation

@Hrushikesh-ramilla

@Hrushikesh-ramilla Hrushikesh-ramilla commented Oct 26, 2026 •

Copy link
Copy Markdown

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

This PR fixes several broken internal links, file paths, and dead anchor targets in the plugin documentation:

  1. plugin-content-blog.mdx:

    • Fixed broken relative link [Blog](blog.mdx) -> [Blog](../../blog.mdx)
    • Fixed dead anchor reference [authors plugin option](#authors) -> [authorsMapPath plugin option](#authorsMapPath) (the plugin option is authorsMapPath)
  2. plugin-content-pages.mdx:

    • Fixed broken relative link [creating pages](guides/creating-pages.mdx) -> [creating pages](../../guides/creating-pages.mdx)
  3. plugin-content-docs.mdx:

    • Replaced site-root /docs/sidebar/... URLs with relative markdown links to items.mdx and autogenerated.mdx (../../guides/docs/sidebar/items.mdx#collapsible-categories, ../../guides/docs/sidebar/items.mdx#expanded-categories-by-default, ../../guides/docs/sidebar/autogenerated.mdx#customize-the-sidebar-items-generator, ../../guides/docs/sidebar/autogenerated.mdx#using-number-prefixes, ../../guides/docs/sidebar/autogenerated.mdx#autogenerated-sidebar-metadata) to follow Docusaurus conventions and preserve versioning/localization.
  4. theme-configuration.mdx:

    • Fixed broken relative links [static folder](static-assets.mdx) -> [static folder](../../static-assets.mdx) in navbar and footer logo descriptions.

Test Plan

  • Ran pnpm typecheck in website to verify docs integrity.
  • Verified all link targets and anchor references resolve to valid files and headings.

Test links

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

  • /docs/api/plugins/@docusaurus/plugin-content-blog
  • /docs/api/plugins/@docusaurus/plugin-content-docs
  • /docs/api/plugins/@docusaurus/plugin-content-pages
  • /docs/api/themes/configuration

Summary by CodeRabbit

  • Documentation
    • Updated API reference links to point to the correct guides for blog, docs, pages, theme configuration, and static assets.
    • Clarified that authorsMapPath configures the YAML authors file path.

@meta-cla meta-cla Bot added the CLA Signed Signed Facebook CLA label Oct 26, 2026
@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: 48ba3934-697c-4bdd-81da-ef20586ed6f6
Commits

Reviewing files that changed from the base of the PR and between 4e6fe61 and 1bd98b0.

Files selected for processing: 4
  • website/docs/api/plugins/plugin-content-blog.mdx
  • website/docs/api/plugins/plugin-content-docs.mdx
  • website/docs/api/plugins/plugin-content-pages.mdx
  • website/docs/api/themes/theme-configuration.mdx

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

Walkthrough

The API documentation now uses updated relative paths for guide links. The blog plugin’s authors-file instructions now refer to authorsMapPath.

Changes: API Documentation

Layer / File(s) Summary
Update API documentation references
website/docs/api/plugins/plugin-content-blog.mdx, website/docs/api/plugins/plugin-content-docs.mdx, website/docs/api/plugins/plugin-content-pages.mdx, website/docs/api/themes/theme-configuration.mdx
Updated guide links to relative paths. The blog plugin’s authors-file instructions now identify authorsMapPath as the option for configuring the YAML authors file path.

Priority: Low

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

Change: Other

Suggested labels: pr: maintenance

Merge Risk: Minimal · up to 1bd98

The documentation-only changes introduce no identified merge-blocking risk.

Architecture risk: Low · up to 1bd98

The change affects 1 system.

Changed systems: website

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — website (api) was modified; 4 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in website/docs/api/plugins/plugin-content-blog.mdx: The Blog feature link changes from blog.mdx to ../../blog.mdx.
  • observed — Modified behavior in website/docs/api/plugins/plugin-content-blog.mdx: The authors-file path instructions now refer to the authorsMapPath plugin option instead of authors.
  • observed — Modified behavior in website/docs/api/plugins/plugin-content-docs.mdx: The references for sidebarCollapsible, sidebarCollapsed, sidebarItemsGenerator, and numberPrefixParser now link to relative guide paths instead of absolute /docs/... paths.
  • observed — Modified behavior in website/docs/api/plugins/plugin-content-docs.mdx: The sidebar_position reference now links to the relative autogenerated-sidebar guide path instead of the absolute /docs/... path.
Pre-merge checks: Passed 5
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 changes: fixing broken links and reference anchors in plugin documentation.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (4 skipped: 4 unsupported.)

Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@netlify

netlify Bot commented Oct 26, 2026

Copy link
Copy Markdown

✅ [V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 1bd98b0
🔍 Latest deploy log https://app.netlify.com/projects/docusaurus-2/deploys/6adf48a44bc510332918724b
😎 Deploy Preview https://deploy-preview-12785--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed Signed Facebook CLA

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant