Skip to content

docs: trim README rot, move full config example to docs/ - #31

Merged
hartsock merged 1 commit into
mainfrom
docs/readme-concision-pass
Sep 9, 2026
Merged

hartsock merged 1 commit into
mainfrom
docs/readme-concision-pass

Conversation

@hartsock

@hartsock hartsock commented Sep 6, 2026

Copy link
Copy Markdown
Member

Summary

  • Roadmap section named a specific phase inline, duplicating docs/ROADMAP.md and guaranteed to drift the moment that file changes — replaced with a plain pointer.
  • "Full config example" was a byte-for-byte duplicate of the targets/rules/notify snippets already shown individually earlier in the README — moved to docs/CONFIGURATION.md, README now links to it.
  • Everything else (what it is, why, quick start, data sources, alert rules, notifications, build, project structure) was already terse and accurate — left alone.
  • README: 1115 → 990 words.

Test plan

  • Grepped workspace-wide for inbound path references to README.md before editing — none found.
  • Verified every markdown link in the repo resolves (README.md, CLAUDE.md, docs/**, monitor-gui/assets/monty/README.md).
  • grep -ri kyln across the repo — no hits.
  • Docs-only diff; no source or dependency files touched.

🤖 Generated with Claude Code

Two spots in the README would go stale in place: the Roadmap section
restated the current phase (already tracked in docs/ROADMAP.md, so it
would drift the moment that changes), and the "Full config example"
was a straight duplicate of the targets/rules/notify snippets already
shown individually above it. Moved the combined example to
docs/CONFIGURATION.md and pointed to it instead of inlining it twice.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@hartsock
hartsock merged commit a88c60e into main Sep 9, 2026
1 check failed
@hartsock
hartsock deleted the docs/readme-concision-pass branch September 9, 2026 21:27
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