docs: fix stale documentation references#2720
Conversation
- Move `CONTRIBUTING.md`, `SECURITY.md`, and governance files from `docs/` to the repository root for better visibility. - Update documentation links across workflows, issue templates, and release articles. - Point migration and skill development guides to their new locations in the MDX-based documentation structure.
- Synchronize relative links in all i18n README files to reflect the relocation of `CONTRIBUTING.md`, `GOVERNANCE.md`, and `SECURITY.md` to the repository root. - Update documentation paths to point to the new MDX-based structure in `docs/src/app/`. - Fix dashboard image file extension and update contributor asset paths.
houko
left a comment
There was a problem hiding this comment.
Two substantive concerns plus a couple of smaller items.
🚨 The new targets are .mdx source files, not the deployed docs
Every updated link in README, i18n READMEs, and release articles now points at docs/src/app/.../page.mdx. These are the Next.js source files for the docs site — GitHub renders .mdx as code, so clicking "Details" / "Full list" / "API Reference" from README lands readers on raw JSX source. That's worse UX than the pre-PR 404s we were trying to fix.
The same README line already has [Documentation](https://docs.librefang.ai), so the deployed site exists and the author is aware of it; the rest of the links just didn't follow suit.
Since docs/src/app/ uses Next.js App Router, src/app/FOO/BAR/page.mdx maps to /FOO/BAR on the deployed site. So:
| This PR targets | Should be |
|---|---|
docs/src/app/getting-started/comparison/page.mdx |
https://docs.librefang.ai/getting-started/comparison |
docs/src/app/configuration/providers/page.mdx |
https://docs.librefang.ai/configuration/providers |
docs/src/app/integrations/channels/page.mdx |
https://docs.librefang.ai/integrations/channels |
docs/src/app/integrations/api/page.mdx |
https://docs.librefang.ai/integrations/api |
docs/src/app/integrations/mcp-a2a/page.mdx |
https://docs.librefang.ai/integrations/mcp-a2a |
docs/src/app/integrations/migration/page.mdx |
https://docs.librefang.ai/integrations/migration |
docs/src/app/operations/troubleshooting/page.mdx |
https://docs.librefang.ai/operations/troubleshooting |
docs/src/app/getting-started/page.mdx |
https://docs.librefang.ai/getting-started |
⚠️ Visible link text and target drifted apart (7 localized READMEs)
+See [docs/comparison.md](docs/src/app/getting-started/comparison/page.mdx) for benchmarks ...
+Siehe [docs/comparison.md](../docs/src/app/getting-started/comparison/page.mdx) für Benchmarks ...
+查看 [docs/comparison.md](../docs/src/app/getting-started/comparison/page.mdx) 了解 ...en/de/es/ja/ko/pl/zh all leave the visible label as docs/comparison.md while the href switches to the .mdx path. Either make both sides agree, or replace the label with a human-readable string like "Comparison" / "benchmarks".
📝 Smaller items
- Anchor fragments dropped.
docs/comparison.md#16-security-systems--defense-in-depth→.mdxpath with no fragment. Readers clicking the "16 Security Layers" bullet now land at the top of the comparison page rather than the relevant section. If the targets becomedocs.librefang.ai/..., the anchors should be regenerated against the MDX headings. - PR description is misleading about scope. The title and body say "relocate
CONTRIBUTING.md/SECURITY.md/GOVERNANCE.md/CODE_OF_CONDUCT.mdfromdocs/to repo root". Those four files are already at the repo root onmain— they were moved in an earlier PR — and this PR doesn't touch them. What this PR actually does is update every reference from the olddocs/*.mdpaths to the new.mdxpaths, covering not just those four files but alsoapi-reference,getting-started,troubleshooting,comparison,providers,channel-adapters,MIGRATION, andMAINTAINERS. Reviewers reading the body won't know to verify the ~28 article and i18n edits.
✅ What does look good
- All new
.mdxtarget files exist onmain(spot-checked 7 of them). - The i18n READMEs correctly add the
../prefix when moving fromi18n/todocs/. .github/CODEOWNERSupdates line up with the actual file locations.
Suggestion
Happy to push a follow-up commit that rewrites the .mdx paths to https://docs.librefang.ai/... URLs and re-aligns the visible labels. That way these links actually reach rendered documentation instead of source files.
Change .mdx source links to deployed docs.librefang.ai URLs. Fix label mismatches where visible text was 'docs/comparison.md' but target was .mdx. Add anchor fragment for security layers comparison section.
houko
left a comment
There was a problem hiding this comment.
Correct direction — the repo had stale docs/*.md references pointing at files that were moved to repo root or migrated to the docs site. This PR catches most of them in one pass. One inline + three notes below.
PR description nit. The summary says "Move CONTRIBUTING.md, SECURITY.md, GOVERNANCE.md, CODE_OF_CONDUCT.md from docs/ to repo root", but those four files already exist at repo root on main (verified via git ls-tree; docs/CONTRIBUTING.md etc. do not exist on main). The actual work here is updating the references that survived that earlier move — not performing the move itself. Worth retitling, and adding a bullet for the legitimate dashboard.jpg -> dashboard.png image-link fix in the i18n READMEs that the description currently omits.
Two stale refs the pass missed (can't inline since these files aren't touched by this PR):
examples/custom-channel/README.md:283—See [docs/channel-adapters.md](../../docs/channel-adapters.md) for the full architecture reference...— user-visible broken link. Same treatment as README.md:144 → https://docs.librefang.ai/integrations/channels.CONTRIBUTING.md:87— code-block comment# See docs/skill-development.md for the skill format— low priority (inside a code fence, not a rendered link) but keeps the cleanup complete. Same target as README.md:119 → https://docs.librefang.ai/agent/skills.
Inline note on the one real regression below.
houko
left a comment
There was a problem hiding this comment.
LGTM — spot-checked the link targets: all five root-level files (CONTRIBUTING.md, SECURITY.md, GOVERNANCE.md, MAINTAINERS.md, CODE_OF_CONDUCT.md) exist, and the MDX paths (docs/src/app/agent/skills/page.mdx, docs/src/app/integrations/migration/page.mdx) are present. Docs-only cleanup, low risk.
Tiny nit (follow-up, non-blocking): the README "Comparison" link near the bottom reuses the #16-security-systems--defense-in-depth anchor from the "16 Security Layers" bullet, which narrows the target to a subsection rather than the whole comparison page. A later patch can drop the anchor there.
Type
Summary
Update stale documentation references that still pointed to old
docs/*.mdpaths after those docs were previously moved to the repository root or migrated to the docs site.Changes
dashboard.jpg->dashboard.pngimage links in localized READMEsCONTRIBUTING.mdand example docs/commentsContributinglink line across 7 README filesAttribution
Co-authored-by, commit preservation, or explicit credit in the PR body)Security