Skip to content

docs(audit): fix broken internal markdown links#19

Merged
SchwartzKamel merged 1 commit into
mainfrom
docs/audit-2026-05-link-integrity
May 3, 2026
Merged

docs(audit): fix broken internal markdown links#19
SchwartzKamel merged 1 commit into
mainfrom
docs/audit-2026-05-link-integrity

Conversation

@SchwartzKamel

Copy link
Copy Markdown
Owner

Pass 3 of the 2026-05 docs audit: link integrity.

Scope

Walked every inline and reference-style markdown link in:

  • docs/*.md (26 files)
  • AGENTS.md, README.md, CONTRIBUTING.md, CHANGELOG.md
  • .github/copilot-instructions.md

External http(s):// links skipped. Verified file existence + anchor
existence (explicit <a id="x"> and slugified markdown headings).

Results

metric value
files scanned 31
inline links scanned 656
broken targets found 3
broken anchors found 0
post-fix broken 0

The PR #17 fix in docs/LEARNING_LOOP.md for docs/AUTOPILOT.md is
verified clean — not re-fixed.

Broken-link inventory

location target reason fix applied
docs/DEVELOPING.md:181 ../src/Drederick/Exploit/ICredTool.cs interface does not exist; credential-attack tools (PasswordSprayTool, KerberoastTool, AsRepRoastTool) implement IExploitTool unlinked ICredTool, kept prose, clarified that the marker is not yet split out
docs/DEVELOPING.md:326 ../tests/fixtures/bin/ directory does not exist (tests/fixtures/ contains only data fixtures: nmap XML, NVD mini, GHSA / Tenable / searchsploit samples — no fake-binary replay subdir yet) unlinked path, kept prose describing intended layout
docs/PLUGIN_STRATEGY.md:218 ../src/Drederick/Exploit/ICredTool.cs same as DEVELOPING.md unlinked, annotated as planned

Why these fixes (not deletes / not stubs)

Per the audit fix policy: the ICredTool interface is referenced in
prose as a real concept but the file does not exist. Cred tools
implement IExploitTool today (verified via grep on
PasswordSprayTool.cs / KerberoastTool.cs), so the prose is updated
to reflect actual code. tests/fixtures/bin/ is an aspirational layout
— left in prose, link removed so readers don't get a 404.

No target docs were fabricated. No code was changed.

Coordination

Touches only docs/DEVELOPING.md and docs/PLUGIN_STRATEGY.md
disjoint from docs-audit-llm-tool-coherence and
docs-audit-root-readme-quickstart zones.

Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com

@SchwartzKamel SchwartzKamel merged commit 29008c2 into main May 3, 2026
2 checks passed
@SchwartzKamel SchwartzKamel deleted the docs/audit-2026-05-link-integrity branch May 3, 2026 01:23
Pass 3 of the 2026-05 docs audit: link integrity. Walked all 656
inline markdown links across 31 files (docs/*.md, AGENTS.md, README.md,
.github/copilot-instructions.md, CONTRIBUTING.md, CHANGELOG.md). Found
3 broken targets, all pointing at code paths that do not exist.

Inventory:

- docs/DEVELOPING.md:181 -> ../src/Drederick/Exploit/ICredTool.cs
  Interface does not exist; cred tools (PasswordSprayTool,
  KerberoastTool, AsRepRoastTool) currently implement IExploitTool.
  Fix: removed the broken link and clarified in prose that a dedicated
  ICredTool marker is not yet split out.

- docs/DEVELOPING.md:326 -> ../tests/fixtures/bin/
  Directory does not exist (tests/fixtures/ has only data fixtures,
  no fake-binary replay subdir yet).
  Fix: un-linked the path; prose still describes the intended layout.

- docs/PLUGIN_STRATEGY.md:218 -> ../src/Drederick/Exploit/ICredTool.cs
  Same as above. Fix: un-linked ICredTool and annotated as planned.

Post-fix: 0 broken links across 653 surviving inline references.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant