Repository navigation
docs(engine): correct docs against the code - #1172
Merged
Merged
Conversation
Fix or cut every claim in README.md and docs/ that contradicts the code, the dfe-schemas wheel or the named sibling repos. Rewrite four pages about unbuilt or outdated designs to match the code: the edge auth page, the CLI design, the commit standard and the engine-loader schema contract. Remove the hyperdx fork maintenance page because its rebase model is outdated. Point the integrations index at the fork's own runbook. Move the reference index's one link into docs/README.md. Every touched page passes hyperi-ai docs prose check with no deny. hyperi-ci lint-docs passes.
The edge auth table says which routes take an OIDC SecurityPolicy with gateway OIDC off and on. It names Kafbat's own login. It cites the network-policies chart for what lets traffic into the DFE namespaces. Reword bold-lead bullets and two sentences starting with a capitalised repo name.
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.
Correct README.md and docs/ against the engine code, the dfe-schemas wheel, openapi.json and the named sibling repos at origin/main. The generated route map is unchanged.
558 ledger rows: PASS 378, FAIL 104 (fixed), register or structure FAIL 60 (fixed), UNCHECKABLE 13, accepted 2, rejected 1.
hyperi-ai docs claimsFAIL results drop from 709 to 689. The 689 results cover:Rewrite four pages about designs that were never built or have since moved: the edge auth page, the CLI design, the commit standard and the engine-loader schema contract.
Delete the hyperdx fork maintenance page's superseded rebase model. The integrations index links the fork's own runbook. Fold the one-link reference index into docs/README.md.
Every touched page passes
hyperi-ai docs prose checkwith no deny.hyperi-ci lint-docspasses:On dfe-hyperdx origin/main, jwt-verify.ts reads
hyperdx_rolefrom /auth/me and runs refuseReadOnlyWrites (role-claim.ts:12, :67, :92)._timestamp_loadpartitions and expires._timestampreads the record'stimestamp<name>_land/<name>_loadmetadata.capture_modeandtable_capture_modes/api/v1trust_proxy_auth_headers(settings.py:1512-1521, default false)SQL_current_tenant_id(governance/ch/render.py:181)rg reference/README)_timestamp_loaddefault, overridabledfe usage getexprin the example and field table