Repository navigation
docs(archiver): redraw diagrams and correct documentation - #183
Merged
Merged
Conversation
The four diagrams fail the diagrams standard: no title, description or caption, vertical chains with five-line node labels, and skip arrows on the CI chart. Each is redrawn from the code. The pipeline becomes the repo's L3 component diagram, with a table naming the code behind each step. The release flow becomes its L4 child. Fix the README claim that --config is the only command-line setting. scalo's CLI takes --log-level, --log-format, --metrics-addr, -v and -q. The restore example named a file the writer cannot produce. Restore the work_config health component to the idle note. internals.md says GCS uploads have no CI test. Config comments that restated a key or labelled a group are cut from the Cargo manifests, .hyperi-ci.yaml, docker-compose.dev.yaml and _typos.toml. No value changes.
Replace 103 of the 106 words flagged by house style in README.md and docs/ with plain wording. Examples: own, also, only, while, refuses, whose. The 3 left are part of a term or express a comparison. Fold 7 headings into paragraphs: three in architecture.md, two in design.md and two in archiving.md. Each covered one short paragraph or table. README.md keeps its headings because a test splits it on "## Storage Backends". Join the two-line comment in _typos.toml into one line.
delivery.md says the sync or upload starts when the file closes. The close step is in the paragraph under the diagram. A close node would make a sixth column, past the diagram limit of five. The CI diagram labels the commit-check arrow "landing". A line under the caption lists its triggers from hyperi-ci rust-ci.yml: a push to main, a pull request and a merge queue group.
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.
Redraws the 4 diagrams in docs/ and corrects README.md. Changes are docs and config comments. No value or code changes.
830 claims: 427 PASS, 6 FAIL fixed, 1 restored, 396 UNCHECKABLE. Most UNCHECKABLE claims are prose the claims tool cannot parse. object_store's credential order is UNCHECKABLE.
The 75 FAILs from
hyperi-ai docs claimsconcern example paths, image names and scalo or object_store names. Each matches its defining file.--config:--log-level,--log-format,--metrics-addr,-vand-q.work_confighealth component reportsDegraded.Changes from the six docs PRs since 2026-11-12 stay: #172, #174, #175, #176, #177 and #181, apart from the idle note. The two README diagrams #172 removed repeat the pipeline in internals.md, so they stay removed.
The 4 diagrams had missing captions, vertical chains and skip arrows. All 4 render
ok. Light and dark screenshots are checked.internals.md has the L3 diagram and a table naming the code behind each step. delivery.md has its L4 release flow.
Config comment lines removed: Cargo.toml 12, crates/archiver 5, crates/core 6, crates/io 3, .hyperi-ci.yaml 5 and docker-compose.dev.yaml 19. _typos.toml comment lines drop from 33 to 4.