Skip to content

docs(logreducer): check every claim against the code - #32

Merged
catinspace-au merged 2 commits into
mainfrom
docs/suite-review
Nov 16, 2026
Merged

catinspace-au merged 2 commits into
mainfrom
docs/suite-review

Conversation

@catinspace-au

Copy link
Copy Markdown
Contributor

Fix claims in README.md and docs/. Redraw the diagrams to the house diagram standard.

Of 81 claims, 59 PASS, 18 fixed (17 wrong, 1 missing), 4 UNCHECKABLE. The 4 UNCHECKABLE claims are timings and memory figures from past runs with no tests to check them.

The docs claims checker reports 7 FAILs, all false alarms: two example branch names, three paths that exist in dfe-infra and dfe-engine, a dotted classmethod and a hyperi-ai standard.

  • temporal mode does not stream. The README said only the anomaly branch could not.
  • "every sample is seeded" was false. Unseeded SQL samples are accepted. reduce_to_target draws fresh batches.
  • the severe-line store grows with distinct ERROR, FATAL and CRITICAL messages. The docs said nothing grows.
  • the enhanced level skips fuzzy dedup without the enhanced extra.
  • max_clusters=None evicts nothing. The docs said it kept evicted results.

Restore the mode-choice diagram deleted by #29, the ClickHouseSource example and three severe-line rules:

  • severe lines match any case
  • severe-line handling applies however a file is read
  • databases sample first

#30 and #31 are kept.

Replace 4 failing diagrams (4 FAIL) with 5 that render on Mermaid 12.3.0 in light and dark screenshots. L3 Components is in docs/architecture.md. The four L4 diagrams link to it.

Trim config comments in pyproject.toml, .gitattributes, .gitleaks.toml and .hyperi-ci.yaml. No value changes. pyproject.toml parses to identical data. Fold docs/README.md into the README because its links are duplicates.

No code changes.

- Restore the mode-choice diagram, ClickHouseSource library example and severe-line rules dropped by #29. Severe-line matching works in any case, however a file is read. Databases sample first.
- Document that temporal mode does not stream. The severe-line store grows. Unseeded SQL samples are accepted. `max_clusters=None` evicts nothing. Fuzzy dedup needs the `enhanced` extra.
- Redraw all five diagrams as Mermaid L3 and L4 diagrams that pass diagram_check.py. architecture.md holds the top-level diagram.
- Fold the link-only docs/README.md into the README.
- Shorten config comments in pyproject.toml, .gitattributes, .gitleaks.toml and .hyperi-ci.yaml to pointers and short reasons. No values change. pyproject.toml parses to the same data.
- Drop a CONTRIBUTING paragraph because dfe-engine declares the dependency.
- Cut or replace 53 banned words in README.md, CONTRIBUTING.md and docs/. Six stay where they name a key, a rule or a fixed heading.
- Turn 9 headings into paragraphs. CONTRIBUTING loses a command list that repeated its Context section.
- Date the architecture test-run figures. Give the Drain3 timing as a ratio.
@catinspace-au
catinspace-au merged commit 7fd9433 into main Nov 16, 2026
17 checks passed
@catinspace-au
catinspace-au deleted the docs/suite-review branch November 16, 2026 01:52
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