Skip to content

docs(loader): fix docs claims and redraw diagrams - #356

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

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

Conversation

@catinspace-au

Copy link
Copy Markdown
Contributor

Docs claims under docs/ and in the README match the code. Diagrams follow the diagrams standard. Config comments are cut back to pointers and reasons.

All 21 original diagrams failed the checker's source check. All 22 replacement diagrams pass with Mermaid 12.3.0. The top diagram is docs/README.md Figure 1, L3 Components. hyperi-ci lint-docs parses all 22 blocks with no warning.

Config files trimmed: Cargo.toml, config.dev.yaml, .config/nextest.toml, .hyperi-ci.yaml, .tarpaulin.toml, docker-compose.dev.yaml, deny.toml. Values unchanged: each file with comments stripped matches main.

No code changes.

Fix Eleven incorrect claims across docs/ and the README. Remove the claim that reputation enrichment flags VPN, Tor, proxy and botnet traffic. It loads operator blocklists alone. Only rep_is_malicious is ever set.

The enrichment page opens with its status and links #342.

Redraw all 21 Mermaid diagrams to the diagrams standard. Restore the common-header table diagram as Mermaid. All 22 diagrams pass the checker.

Trim config comments to pointers and reasons. Values unchanged.
The read step's label wrapped to four lines in the rendered diagram, with "paths" alone on a line. It reads "Listed paths or column name" on two.
The directive figure's caption said _timestamp_received skips its directive. The header extractor reads _timestamp_received through Sources::FixedThen: the first hop's edge stamp, then the paths listed by its @source.

The caption names _org_id and _timestamp alone. A line below covers _timestamp_received.

The common-header page says a raw_only or extracted_only table with a _json column counts no unstored fields. The extractor's stores_payload checks whether the column exists. Those modes do not write _json.
@catinspace-au
catinspace-au merged commit 6658f44 into main Nov 16, 2026
14 checks passed
@catinspace-au
catinspace-au deleted the docs/suite-review branch November 16, 2026 04:11
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