Skip to content

docs(architecture): engine page to the standard, diagrams to 860 px - #1209

Merged
catinspace-au merged 2 commits into
mainfrom
docs/arch-standard
Nov 17, 2026
Merged

catinspace-au merged 2 commits into
mainfrom
docs/arch-standard

Conversation

@catinspace-au

Copy link
Copy Markdown
Contributor

docs/architecture.md follows the architecture page standard: an opening L2 view of the repo's three running parts and the CLI. The eight sections follow in order. The API server and hunt runner each get a part page that opens with a fact table and diagram.

The suite-level event path and the control layers diagram are gone from this page. dfe-infra owns the suite view. Figure 1 shows the same callers. The instance deploy path and the compiled source definition moved to the API server page.

Every flowchart in docs/ renders at 860 px natural width or less. Before this change, 39 went over that width. Long chains became stage rows, side-by-side columns or decision rows. Every original arrow is kept.

Two diagrams get missing captions. One diagram loses a duplicate arrow between the same pair.

Up links to the old L3 diagram point at the API server page.

docs/architecture.md follows the architecture page standard: an opening L2 view of the repo's three running parts and the CLI. The eight sections follow in order. The API server and hunt runner each get a part page that opens with a fact table and diagram.

The suite-level event path and the control layers diagram are gone from this page. dfe-infra owns the suite view. Figure 1 shows the same callers. The instance deploy path and the compiled source definition moved to the API server page.

Every flowchart in docs/ renders at 860 px natural width or less. Before this change, 39 went over that width. Long chains became stage rows, side-by-side columns or decision rows. Every original arrow is kept.

Two diagrams get missing captions. One diagram loses a duplicate arrow between the same pair.

Up links to the old L3 diagram point at the API server page.
dfe-infra's bootstrap rejects mesh. No release ships it. Remove the mesh profile from every engine doc, its listener section and both diagram uses. The receiver buffer section gives the behaviour without the mesh overlay's figures.

hunt-runner-scaling.md said `dfe-hunt-runner materialise` is the only caller of `publish_schedule`. The phase smoother calls it (smoothing.py:336). The page names both writers.

CONTRIBUTING.md Context lists gitcrud, sigma, kafka, hyperdx, governance/ch, hunts and keda_shim. The architecture page no longer maps them.
@catinspace-au
catinspace-au merged commit 0c8991a into main Nov 17, 2026
14 checks passed
@catinspace-au
catinspace-au deleted the docs/arch-standard branch November 17, 2026 03:32
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