Skip to content

docs(transform-vrl): correct docs and redraw both diagrams - #156

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

Correct the README, docs/ and the filebeat bundle README against the code, scalo-rs 2.14.30 and dfe-infra. Changes are to docs and config comments. No code or config values change.

Claim results

  • hyperi-ai docs claims on the five pages: 409 claims, 217 PASS, 167 UNCHECKABLE, 25 FAIL. All 25 are false alarms for dependency and chart names, sibling-repo paths, RFC 5737 ranges.
  • 68 rows: 58 PASS, 2 UNCHECKABLE, 8 FAIL. All 8 failures are fixed.
  • Docs findings: 5 P2, 7 P3. 10 fixed, 2 rejected: the diagram standard needs the intro sentence.

Restored

Diagrams

  • Before: 2 failed the checker. architecture.md was 1094 px tall with two skip arrows. internals.md was 1476 px wide.
  • After: 2 are ok under Mermaid 12.3.0. architecture.md shows an L3 of the service. internals.md shows an L4 of the process closure.

Config comments trimmed

  • .hyperi-ci.yaml: 7 lines cut, 1 pointer added.
  • Cargo.toml: 13 cut, 3 added.
  • deny.toml: 3 cut, 1 added.
  • Makefile: 3 trailing target comments cut.

Align the README, docs/ and the filebeat bundle README with the code, scalo-rs 2.14.30 and dfe-infra.

- Redraw the architecture diagram as an L3 of the service and the internals diagram as an L4 of the process to match the diagram standard.
- `pipeline.name` sets no consumer group or metric label.
- Source and sink transports are chosen separately.
- The Push retry stops on a permanent failure.
- Enrichment lookups use equality indexes on the key columns alone.
- The library chart's `reload.*` values roll pods on a credential rotation.
- Restore `source.commit_interval_ms` to the inert list.
- Restore the scalo line in the README.
- Label the filebeat bundle legacy in the README.
- Trim config comments in Cargo.toml, .hyperi-ci.yaml, deny.toml and the Makefile to pointers and short reasons. No value changes.
The intro sentences above the architecture and internals diagrams say what each diagram shows.
@catinspace-au
catinspace-au merged commit 7063457 into main Nov 16, 2026
14 checks passed
@catinspace-au
catinspace-au deleted the docs/suite-review branch November 16, 2026 02:53
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