Repository navigation
docs(architecture): engine page to the standard, diagrams to 860 px - #1209
Merged
Merged
Conversation
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.
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.
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.