Repository navigation
docs(logreducer): check every claim against the code - #32
Merged
Merged
Conversation
- 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
reduce_to_targetdraws fresh batches.enhancedlevel skips fuzzy dedup without theenhancedextra.max_clusters=Noneevicts nothing. The docs said it kept evicted results.Restore the mode-choice diagram deleted by #29, the ClickHouseSource example and three severe-line rules:
#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.