docs: align the public surface with contract v6.10.0 - #138
Draft
jadoonf wants to merge 1 commit into
Draft
Conversation
README caption and comment anatomy, the v6.2 note, and the tokenless spec all described pre-v6.10 shapes. Also documents GARNET_JIBRIL_STOP_TIMEOUT_SECONDS.
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
Execution Profiles recorded for 1 job, triggered by
|
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.
Summary
Docs and README only. No
src/, nodist/. The renderer in this repo already emits contract v6.10.0 (src/runtime-review-vocab.jsis 6.10.0, vendored from testbedmainb2fa17a;test/renderer-v670.test.jsgates the delta partition and the boundary label). The public surface still described v6.9.5, v6.2, and v6.1 shapes.What was stale, and what it says now
README screenshot caption — said "renderer v6.9.5". The screenshot itself is a v6.9.5 capture: its meta line is the old single line (
19 destinations · recorded at the kernel by Garnet · 2026-07-13 23:54:31 UTC). Rather than relabel a stale image, the caption now names both: the renderer emits v6.10.0, this capture is from v6.9.5, before the meta block split. Follow-up: recapture the screenshot from a v6.10.0 comment and drop the caveat.README comment anatomy — the metadata bullet described the pre-v6.10 single line. It now describes the two-line meta block (italic finding line, then the quiet provenance line at minute precision) and the three finding variants. The comparison paragraph gained one sentence for the workload/background delta partition: deltas count your workflow's destinations, background movement is counted by the
(runner background · +A −B)label on the root above its own marks.README configuration — new "Environment variables" table documenting
GARNET_JIBRIL_STOP_TIMEOUT_SECONDS(default1800). Verified againstsrc/action.js(DEFAULT_JIBRIL_STOP_TIMEOUT_SECONDS,resolveStopTimeoutSeconds, theTimeoutStopSecdrop-in) andsrc/post.js(resolveStopTimeoutSecondsreads the unit's liveTimeoutStopUSecand bounds its wait to it).docs/runtime-review-v6.2.md— four contracts stale. A full rewrite would duplicate the contract, so the page is retitled a historical record of the v6.1 → v6.2 step and carries aWhat v6.10.0 says insteadsection (headline, meta block, folds, delta partition,○terminals, noreachedsentence). The v6.2 sections stay, labelled superseded. The Step Summary section notes that v6.10.0 is lineage-first (Process Tree | Destinations), not the destination-first table it describes. Filename kept so existing links resolve.docs/tokenless-path-spec.md— pinned to v6.1 and to a v6.2 amendment that was never ratified: 6.10.0 has no tokenless, local-only, or upgrade-CTA vocabulary. The status block now says draft-not-implemented and states the two things that moved under it: the contract (with the permalink string nowView this job's Execution Profile in Garnet →, and the record being an Execution Profile, not a Run Profile), and the code —api_tokenis alreadyrequired: falseinaction.yaml, but the local-only branch never landed and the fork path taken since is OIDC behindGARNET_ACTION_ENABLE_OIDC_AUTH. §1's "todayrequired: true" is corrected in place. Its body sections stay as written.Banned vocabulary swept in the touched files: the one hit was "no runtime monitoring" in the tokenless spec, now "records nothing".
Gate
npm run validatepasses on Node 24 (53 tests).dist/is byte-identical after the build — only the three markdown files are modified.Deliberately left for follow-up
src/runtime-review.js's header comment still reads "reference renderer for contract v6.8.0" while the vendored vocab is 6.10.0. It is asrc/edit and would require adist/rebuild, so it is out of this PR's scope.Link to Devin session: https://app.devin.ai/sessions/a3a6af48e1a647c99ad3e43f2928bfb5
Requested by: @jadoonf