Skip to content

docs: add docs audit and fix plan - #44

Closed
mattmattox wants to merge 1 commit into
mainfrom
claude/crud-docs-research-9d9052
Closed

mattmattox wants to merge 1 commit into
mainfrom
claude/crud-docs-research-9d9052

Conversation

@mattmattox

Copy link
Copy Markdown
Contributor

Audit of all 31 markdown files against the code, and a plan to fix them. No doc or code changes yet.

  • About a third of the docs are template leftovers (Nexmonyx/TaskForge) or invented. Most of the rest have wrong type names, ports, endpoints or metrics.
  • The audit also found code bugs: the disk defaults use keys their parser ignores, circuitBreaker config is ignored at startup, make test-e2e runs no tests, and no controller image is built.

Review the "Defaults I picked" section in DOCS_PLAN.md before PR1–PR4 start. These two files get deleted once the plan is done.

🤖 Generated with Claude Code

Audit of all markdown against the code, plus a 9-PR plan to delete
template leftovers, fix wrong facts, and fix the code bugs found.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mattmattox mattmattox closed this Oct 12, 2026
@mattmattox
mattmattox deleted the claude/crud-docs-research-9d9052 branch October 24, 2026 08:48
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