Skip to content

docs: fix outdated, contradicting, and incorrect content across docs#43

Merged
aJesus37 merged 1 commit into
mainfrom
docs/fix-outdated-contradicting-content
Mar 19, 2026
Merged

docs: fix outdated, contradicting, and incorrect content across docs#43
aJesus37 merged 1 commit into
mainfrom
docs/fix-outdated-contradicting-content

Conversation

@aJesus37

Copy link
Copy Markdown
Owner

Summary

  • CONFIGURATION.md: fix JWT expiry (24h→7 days), remove non-existent --host/--database-path flags, fix ctf2 user reference (→UID 1000), align Docker port to 8090, add missing --submission-rate-limit flag documentation
  • OPERATIONS.md: document /healthz and /readyz health check endpoints, correct Prometheus /metrics section (it IS implemented via --metrics flag), fix missing serve subcommand in OTel stdout example
  • CONTRIBUTING.md: remove non-existent task test-coverage, task smoke-test, task e2e-test targets
  • SECURITY.md: update supported version table (0.6.x → 0.8.x), remove placeholder security@yourdomain.com email
  • CLAUDE.md: clean up stale TODO wording on structured logging

Test plan

  • Verify all flag names in CONFIGURATION.md match ./hctf serve --help output
  • Verify /healthz and /readyz endpoints respond correctly on a running instance
  • Verify /metrics is served when --metrics flag is passed

🤖 Generated with Claude Code

- CONFIGURATION.md: fix JWT expiry (24h→7d), remove non-existent --host/--database-path flags, fix ctf2 user reference (→UID 1000), align Docker port to 8090, add missing --submission-rate-limit flag
- OPERATIONS.md: document /healthz and /readyz endpoints, correct Prometheus /metrics (it is implemented), fix missing serve subcommand in OTel example
- CONTRIBUTING.md: remove non-existent task targets (test-coverage, smoke-test, e2e-test)
- SECURITY.md: update supported version table (0.6.x→0.8.x), remove placeholder email
- CLAUDE.md: clean up stale TODO wording on structured logging

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@aJesus37
aJesus37 merged commit 955f1b0 into main Mar 19, 2026
5 checks passed
@aJesus37
aJesus37 deleted the docs/fix-outdated-contradicting-content branch March 19, 2026 01:10
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