docs: fix 21 broken doc links in README (closes #58)#61
Merged
Conversation
The top-level README referenced 25 relative .md files. 21 were 404s because the doc tree uses subdirectories with descriptive filenames (docs/core-concepts/runtime-engine.md, docs/security/secret-management.md etc.) while the README linked to canonical flat names that don't exist on disk. Newcomers clicking "Quick Start", "Architecture", "Skills", "Runtime", "Memory", "Channels", etc. all landed on GitHub 404 pages. Mapping applied to README.md (Option A from the issue — pure link rewrite, no new doc files): docs/quickstart.md -> docs/getting-started/quick-start.md docs/installation.md -> docs/getting-started/installation.md docs/architecture.md -> docs/core-concepts/how-forge-works.md docs/skills.md -> docs/skills/writing-custom-skills.md docs/tools.md -> docs/core-concepts/tools-and-builtins.md docs/runtime.md -> docs/core-concepts/runtime-engine.md docs/memory.md -> docs/core-concepts/memory-system.md docs/channels.md -> docs/core-concepts/channels.md docs/scheduling.md -> docs/core-concepts/scheduling.md docs/security/egress.md -> docs/security/egress-control.md docs/security/secrets.md -> docs/security/secret-management.md docs/security/signing.md -> docs/security/build-signing.md docs/commands.md -> docs/reference/cli-reference.md docs/configuration.md -> docs/reference/forge-yaml-schema.md docs/dashboard.md -> docs/reference/web-dashboard.md docs/deployment.md -> docs/deployment/kubernetes.md docs/hooks.md -> docs/core-concepts/hooks.md docs/plugins.md -> docs/reference/framework-plugins.md docs/command-integration.md -> docs/reference/command-integration.md The three ambiguous entries (Skills, Architecture, Deployment) were resolved by matching each row's description-cell text to the closest existing doc — no new index files needed. Add .github/workflows/docs-links.yaml — a tiny Python step that walks every relative .md link in README.md and fails the build if any resolve to a missing file. Path-filtered so it only runs when README or docs/** change, keeping it out of unrelated PRs. Audit results in the fixed README: before: 21 broken, 4 OK after: 0 broken, 25 OK
This was referenced May 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #58 — the top-level
README.mdreferenced 25 relative.mdpaths and 21 were 404s. Newcomers clicking "Quick Start", "Architecture", "Skills", "Runtime", "Memory", "Channels", "Egress Security", "Secrets", "Build Signing", "Commands", "Configuration", "Dashboard", "Deployment", "Hooks", "Plugins", or "Command Integration" from the README landed on a GitHub 404 page. That's a serious first-impression bug on the project's most visible doc.Approach
Option A from the issue — pure link rewrite, no new doc files. The doc tree uses subdirectories with descriptive filenames (
docs/core-concepts/runtime-engine.md,docs/security/secret-management.md, etc.) but the README linked to canonical flat names that don't exist on disk. Each broken link is updated to point at the existing target.Mapping applied (16 mechanical, 3 resolved by matching each row's description-cell text to the closest existing doc):
docs/quickstart.mddocs/getting-started/quick-start.mddocs/installation.mddocs/getting-started/installation.mddocs/architecture.mddocs/core-concepts/how-forge-works.mddocs/skills.mddocs/skills/writing-custom-skills.mddocs/tools.mddocs/core-concepts/tools-and-builtins.mddocs/runtime.mddocs/core-concepts/runtime-engine.mddocs/memory.mddocs/core-concepts/memory-system.mddocs/channels.mddocs/core-concepts/channels.mddocs/scheduling.mddocs/core-concepts/scheduling.mddocs/security/egress.mddocs/security/egress-control.mddocs/security/secrets.mddocs/security/secret-management.mddocs/security/signing.mddocs/security/build-signing.mddocs/commands.mddocs/reference/cli-reference.mddocs/configuration.mddocs/reference/forge-yaml-schema.mddocs/dashboard.mddocs/reference/web-dashboard.mddocs/deployment.mddocs/deployment/kubernetes.mddocs/hooks.mddocs/core-concepts/hooks.mddocs/plugins.mddocs/reference/framework-plugins.mddocs/command-integration.mddocs/reference/command-integration.mdThe four already-working links (
docs/security/overview.md,docs/security/guardrails.md,CONTRIBUTING.md,CODE_OF_CONDUCT.md) are unchanged.Regression protection — new CI check
.github/workflows/docs-links.yamladds a small job that walks every relative.mdlink inREADME.mdand fails the build if any resolve to a missing file. Path-filtered (README.md,docs/**, the workflow itself) so it only runs on PRs that could plausibly break it.A pure-Python step — no Go toolchain needed for what's really a text check.
Audit results
The script in the workflow is the same one used to produce these numbers.
Acceptance criteria from #58
.mdlink inREADME.mdresolves to a file that exists onmain.Out of scope (intentional, per the issue)
The 34 in-doc cross-references that share the same canonical-name mismatch (e.g.
docs/core-concepts/runtime-engine.mdlinks totools.mdwhich doesn't exist by that name) are not fixed here. The README is the priority because it's the public discovery surface; the in-doc fixes belong in a separate follow-up so this PR stays narrowly README-focused. The CI check landed here is README-only by design — extending it to all docs is a clean next step but a separate decision.