Skip to content

docs: fix stale documentation references#2720

Merged
houko merged 16 commits into
librefang:mainfrom
leszek3737:fix/read_me
Apr 19, 2026
Merged

docs: fix stale documentation references#2720
houko merged 16 commits into
librefang:mainfrom
leszek3737:fix/read_me

Conversation

@leszek3737
Copy link
Copy Markdown
Contributor

@leszek3737 leszek3737 commented Apr 17, 2026

Type

  • Documentation / Translation

Summary

Update stale documentation references that still pointed to old docs/*.md paths after those docs were previously moved to the repository root or migrated to the docs site.

Changes

  • Update README and localized README links from stale local docs paths to current repo-root files or docs site URLs
  • Fix dashboard.jpg -> dashboard.png image links in localized READMEs
  • Update remaining stale references in CONTRIBUTING.md and example docs/comments
  • Fix accidental extra leading space on the Contributing link line across 7 README files

Attribution

  • This PR preserves author attribution for any adapted prior work (Co-authored-by, commit preservation, or explicit credit in the PR body)

Security

  • No new unsafe code
  • No secrets or API keys in diff
  • User input validated at boundaries

- 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.
@github-actions github-actions Bot added size/L 250-999 lines changed area/docs Documentation and guides area/ci CI/CD and build tooling no-rust-required This task does not require Rust knowledge and removed size/L 250-999 lines changed labels Apr 17, 2026
@github-actions github-actions Bot added the ready-for-review PR is ready for maintainer review label Apr 17, 2026
@github-actions github-actions Bot requested a review from houko April 17, 2026 14:42
@github-actions github-actions Bot added the size/L 250-999 lines changed label Apr 17, 2026
Copy link
Copy Markdown
Contributor

@houko houko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.mdx path 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 become docs.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.md from docs/ to repo root". Those four files are already at the repo root on main — 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 old docs/*.md paths to the new .mdx paths, covering not just those four files but also api-reference, getting-started, troubleshooting, comparison, providers, channel-adapters, MIGRATION, and MAINTAINERS. Reviewers reading the body won't know to verify the ~28 article and i18n edits.

✅ What does look good

  • All new .mdx target files exist on main (spot-checked 7 of them).
  • The i18n READMEs correctly add the ../ prefix when moving from i18n/ to docs/.
  • .github/CODEOWNERS updates 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.
@leszek3737 leszek3737 requested a review from houko April 18, 2026 06:00
Copy link
Copy Markdown
Contributor

@houko houko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:283See [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.

Comment thread README.md Outdated
@leszek3737 leszek3737 changed the title docs: relocate core project documents to repository root and update all migrated paths docs: fix stale documentation references Apr 18, 2026
@github-actions github-actions Bot added type/skill New or updated skill (Python/JS/Prompt) and removed no-rust-required This task does not require Rust knowledge labels Apr 18, 2026
@leszek3737 leszek3737 requested a review from houko April 18, 2026 14:31
Copy link
Copy Markdown
Contributor

@houko houko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@houko houko merged commit 7a527f9 into librefang:main Apr 19, 2026
23 checks passed
@github-actions github-actions Bot removed the ready-for-review PR is ready for maintainer review label Apr 19, 2026
@leszek3737 leszek3737 deleted the fix/read_me branch April 19, 2026 12:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/ci CI/CD and build tooling area/docs Documentation and guides size/L 250-999 lines changed type/skill New or updated skill (Python/JS/Prompt)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants