Skip to content

docs(engine): correct claims and redraw diagrams - #1187

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

Correct claims against the code and sibling repos across docs/, the README and CONTRIBUTING. Leave the three pages covered by #1177 untouched.

  • docs claims: 5598 claims with 428 FAIL before, 5958 with 466 FAIL after. Each FAIL left has a reason for rejection. The generated route map accounts for 193.
  • 580 rows: 314 PASS, 159 FAIL fixed or cut, 13 UNCHECKABLE.
  • scripts/generate_openapi.py regenerates with no diff. The spec stays at VERSION.

Corrected docs:

  • The engine applies ClickHouse DDL itself and commits no ddl/ or envoy/ tree.
  • The fork's create-rule button posts to its route. It sends no postMessage to dfe-ui.
  • scalo-rs rejects msk_iam, which two pages offered.
  • main is a core source the API will not modify.
  • If-Match is optional on a write.

Restore the README's sampling bullet dropped by #1152. Keep the other PRs' cuts to text about things never built.

Diagrams: 58 failing Mermaid diagrams and seven text diagrams before, 62 diagrams after. 62 diagram(s), 0 failing, 0 page finding(s) (rendered with Mermaid 12.3.0).

Config comments: 431 lines out, 76 in. No value changed. Files:

  • The three query catalogues
  • pyproject.toml
  • Dockerfile
  • Makefile
  • providers.yaml
  • defaults.yaml
  • docker-compose.dev.yaml
  • .gitleaks.toml
  • .hyperi-ci.yaml
  • One workflow
  • The pipeline template
  • Four default configs

appmgmt/apps.yaml keeps its comments because it copies dfe-infra's file.

838 unit tests that read the touched configs pass. hyperi-ci lint-docs is clean. lychee is not installed. docs slop is clean.

Overlapping open PRs: #1184, #952, #950, #949, #948, #947, #946.

Update claims across every page under docs/, the README and CONTRIBUTING against the code and sibling repos. Pages covered by #1177 are unchanged.

The engine applies ClickHouse DDL itself and commits no ddl/ or envoy/ tree. The fork's create-rule button posts to its route. It sends no postMessage to dfe-ui. scalo rejects MSK IAM.

`main` is a core source the API will not modify. `If-Match` is optional on a write.

Redraw all 58 Mermaid diagrams to the diagram standard. Replace text diagrams with Mermaid or lists where no picture is needed. All 62 diagrams pass the checker on Mermaid 12.3.0.

architecture.md holds L2 Services -- DFE and L3 Components -- dfe-engine.

Cut config comments in 17 files to pointers and short reasons. Move the retained explanations to the docs. No value changes.
Restore "Buffering without a bus" in transports.md. The deployment README links to it. dfe-infra's mesh receiver profile still configures it.

dfe-transform-vector scales on ScalingPressure on the single, scale and mesh profiles, as the archiver and the other transforms do.

The charts poll the shim at /keda/pressure. That path is an alias for the pressure query on the generic /q/{name} route.

The view execution sequence shows the API fetching the view through the executor. ClickHouse answers the executor rather than the API.
@catinspace-au
catinspace-au merged commit 73114b6 into main Nov 16, 2026
19 checks passed
@catinspace-au
catinspace-au deleted the docs/suite-review branch November 16, 2026 03:18
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