Fix broken /api link on intro page (build warning) #65

Closed
opened 2026-03-21 19:27:38 +00:00 by kert · 0 comments
Owner

Problem

Docusaurus build warns:

Broken link on source page path = /:
   -> linking to /api

docs/docs/intro.md contains [API Reference](/api) but /api is not a valid page — it's a directory. The link should point to the first actual page in the API docs.

Fix

  1. Check what pages exist under docs/docs/api/ after generation
  2. Update the link to /api/aco/dag or create an api/index.md that redirects
  3. Change onBrokenLinks from warn to throw to catch future broken links at build time

Files

  • docs/docs/intro.md
  • docs/docusaurus.config.js
## Problem Docusaurus build warns: ``` Broken link on source page path = /: -> linking to /api ``` `docs/docs/intro.md` contains `[API Reference](/api)` but `/api` is not a valid page — it's a directory. The link should point to the first actual page in the API docs. ## Fix 1. Check what pages exist under `docs/docs/api/` after generation 2. Update the link to `/api/aco/dag` or create an `api/index.md` that redirects 3. Change `onBrokenLinks` from `warn` to `throw` to catch future broken links at build time ## Files - `docs/docs/intro.md` - `docs/docusaurus.config.js`
kert added this to the P13: Docs Search — local search, library data, broken links, tests milestone 2026-03-21 19:27:38 +00:00
kert added the docs label 2026-03-21 19:27:38 +00:00
kert closed this issue 2026-03-21 19:34:14 +00:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: homelab/stack#65