Skip to content

docs(fork): match the docs to the code and redraw every diagram - #223

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

Fix 16 wrong claims and redraw every diagram to the house standard. Docs only: no upstream file, config or code changes.

hyperi-ai docs claims: 2603 claims, 959 PASS, 230 FAIL, 1414 UNCHECKABLE. Each FAIL points to an existing package-relative path, an internal detail of a dependency in a dated security record, or a ref or file in a sibling repo.

  • Envoy does not run OIDC in front of HyperDX. The console sets the engine token in the dfe_token cookie. The API verifies it.
  • The alert checker still starts. Admin lockdown and the embed's route block keep alerting off. ADRs 0002 and 0003 are marked superseded.
  • DFE runs no HyperDX OpAMP-managed collector.
  • docker-local.md opens with a status line: the caps layer fails to load.
  • Fix the blank DocumentDB login in the production command in getting-started.md. Fix its dead engine link.
  • Correct Renovate, CodeQL, file names and the docs catalogue in design.md, sync-cycle.md and what-we-changed.md.

Keep PRs #207, #209, #214 to #218. Restored 0, reverted 0.

Replace 26 diagrams that fail the checker with 27 that pass on Mermaid 12.3.0. Replace a text arrow block with a table. Replace eight dependency-chain fences with prose. The sync track record has a separate page.

Unfixed problems:

  • docker-compose.caps.yml still caps two removed services, so compose rejects it.
  • Six upstream doc files have prettier-only changes on .fork-surface. The webhook page differs on 91 lines for four words.

The architecture pages said Envoy runs OIDC in front of HyperDX and passes identity headers. The gateway has no OIDC policy on the HyperDX route. The console sets the engine token in the dfe_token cookie. The API verifies that token against the engine's JWKS.

The auth, deployment and catalogue pages describe this auth flow. The dated security records correct their claims about gateway auth.

The alert checker still starts in the image. The engine-only /alerts and /webhooks routes and the embed's route block keep alerting off. ADR 0002 and the pages that cite it describe these blocks. ADR 0003 is marked superseded.

docker-compose.caps.yml still caps two services removed by the DocumentDB move. compose rejects every command that layers it. docker-local.md opens with this warning. The dev flow points at yarn dev:dfe, since the DFE dev override scales ClickHouse to zero.

All 27 mermaid diagrams pass the diagram checker on Mermaid 12.3.0. The text arrow chains became prose or a table. The sync track record moved to its own page.
The gateway chart puts no OIDC policy on the HyperDX route by default. The OIDC page names the three settings that change this default: routes.hyperdx.edgePolicy, oidc.targetRoutes and jwtAuthn.

The docker-local dev command drops the caps files. compose rejects those files. The container command is marked as needing a caps file that loads.
@catinspace-au
catinspace-au merged commit d8cbb43 into main Nov 16, 2026
34 checks passed
@catinspace-au
catinspace-au deleted the docs/suite-review branch November 16, 2026 05:40
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