Skip to content

docs: correct claims that no longer match the code - #445

Merged
retr0h merged 1 commit into
mainfrom
fix/documentation-drift
Aug 16, 2026
Merged

docs: correct claims that no longer match the code#445
retr0h merged 1 commit into
mainfrom
fix/documentation-drift

Conversation

@retr0h

@retr0h retr0h commented Aug 16, 2026

Copy link
Copy Markdown
Collaborator

Part of correct-documentation-drift.

  • CLAUDE.md described nats-client and nats-server as linked via a replace directive. go.mod has no replace; both are pinned module versions.
  • CLAUDE.md named printKV and printStyledTable in cmd/ui.go. Neither symbol nor that file exists — the helpers are cli.PrintKV and cli.PrintCompactTable in internal/cli/ui.go.
  • system-architecture.md located the notifier at internal/notify/; it is internal/controller/notify/.
  • configuration.md said two fields carry a required tag. Seven do — five have viper.SetDefault() values, so only two must be set. Its table also carried two controller.metrics rows pasted from the environment-variable table above it.
  • intro.md prefixed four links with sidebar/ while already inside sidebar/, and linked category/api without the leading slash the other five references use.

just md-fmt-check and just docusaurus-fmt-check clean.

🤖 Generated with Claude Code

CLAUDE.md described nats-client and nats-server as linked via a
replace directive; go.mod pins them as module versions. It also
named printKV and printStyledTable in cmd/ui.go; the helpers are
cli.PrintKV and cli.PrintCompactTable in internal/cli/ui.go.
Configuration counted two required fields where seven carry the tag,
and its table carried two metrics rows pasted from above it.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@codecov

codecov Bot commented Aug 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #445   +/-   ##
=======================================
  Coverage   99.94%   99.94%           
=======================================
  Files         484      484           
  Lines       24935    24935           
=======================================
  Hits        24921    24921           
  Misses         14       14           

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 734e5eb...05f0c1e. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@retr0h
retr0h merged commit e3c8be0 into main Aug 16, 2026
12 checks passed
@retr0h
retr0h deleted the fix/documentation-drift branch August 16, 2026 04:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant