Repository navigation
docs(elastic): fix docs to match the code - #186
Merged
Merged
Conversation
Wrong claims in README.md, CONTRIBUTING.md and docs/ are fixed or cut. The nine Mermaid diagrams follow the diagrams standard. All nine failed the checker before and pass it after the changes. - The architecture page drew a TransformChain the service never runs. It shows the four steps, the crate graph, one batch as a sequence, and what a failed processor does. - Pages describing the parity corpus test, its baseline and its fixture format are cut to what this repository holds: compare-policy.yaml and the known limits. - Docs mark layers 2 and 3 of dfe-parse, the dfe-parsers crate and schema generation as built but unused, or as designs. The dfe-parsers section is cut. - configuration.md documents the bad-input counters, the metrics-manifest subcommand and /scaling/pressure. - Config comments are cut to a pointer or a one-line reason in 15 files. Every parsed value is identical before and after. - src/envelope.rs: doc comments only. Envelope detection runs for each event in a batch.
The docs describe the compare policy without corpus or scoring details.
- compat.md covers compare-policy.yaml and two known limits. The scoring diagram and scoring process description are removed.
- Remove corpus mentions and detector benchmark figures from parity.md, testing.md, configuration.md, parsers.md, schema-generation.md and CONTRIBUTING.md.
- testing.md no longer calls `Exact` the default match mode. MatchMode has no default.
- src/envelope.rs doc comments say auto detection runs per event. docs/config-schema.{json,yaml} and docs/deployment-contract.json are regenerated with `generate-artefacts`.
CONTRIBUTING.md drops the DCO section removed on main. Its pull request steps drop sign-off. Cargo.toml keeps main's psl >=2.1.248 under the branch's shorter comment. .prose-exemptions.yaml goes, because the DCO text it covered is gone.
Main's #187 sends an event over sink.max_message_bytes to the DLQ. The architecture page keeps the branch's layout. Its one-record paragraph names serialise_events_with_oversize and the DLQ. The configuration page uses main's DLQ wording and the branch's word choices.
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.
Incorrect claims in the README, CONTRIBUTING and docs/ are fixed or cut.
hyperi-ai docs claimsreports 35 FAIL rows, all false alarms: Elastic processor names, dfe-engine identifiers and env names composed at runtime.lossy_payloads_total,parse_errors_totalandsend_backpressure_totalcounters.metrics-manifestsubcommand./scaling/pressure.tests/compare-policy.yamland the known limits. The parity corpus and its test are absent from this repo.Device Vendor, a CEF header field name.