You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs(operate): reshape the check-mode, private-repositories, snapshot, and troubleshooting pages for skimming - #428
- The document follows in the one canonical order every rendered document has (`mode: render` writes the same one): the sections in the order the action applies them, each section's keys as the schema declares them, the entries of every keyed list sorted by their identity (a label's `name`, a webhook's `config.url`, a deploy key's `title`; `branches` keep their order, since GitHub applies overlapping wildcard rules in creation order, pinned environments keep theirs, since it is the pin rank, and the next paragraph names the lists with no identity), every knobbed list section (the sections the undeclared policy counts) in its `{_undeclared, entries}` wrapper form with the section's default policy spelled out, and `environments`, `branches`, and `workflows` as bare lists, since their wrapper takes no policy. An apply from the file does exactly what the header says, and two snapshots of one repository are the same bytes. The lists left as written keep the order GitHub lists them in: ... (212 words)
After
- The document follows in the one canonical order every rendered document has (`mode: render` writes the same one), stated below. An apply from the file does exactly what the header says, and two snapshots of one repository are the same bytes.
The canonical order, outermost first:
-**Sections:** in the order the action applies them.
-**Each section's keys:** as the schema declares them.
-**Every knobbed list section:** in its `{_undeclared, entries}` wrapper form with the section's default policy spelled out. `environments`, `branches`, and `workflows` are bare lists, since their wrapper takes no policy.
-**The entries of every keyed list:** sorted by their identity (a label's `name`, a webhook's `config.url`, a deploy key's `title`). Two lists keep their order instead: `branches`, since GitHub applies overlapping wildcard rules in creation order, and pinned environments, since it is the pin rank.
-**The lists with no identity:** left as written, in the order GitHub lists them in.
How
Every over-cap unit on the four pages becomes the device that shows it fastest: split paragraphs, bold-lead-in bullets, a result-and-exit table, numbered steps.
Six restated facts (the warn-to-partial rule, the preflight probe, the 404 reading, bypass_actors visibility, issue channels in check mode, the GITHUB_TOKEN limit) now link to the page that owns each, keeping only the clause the local reader needs.
No fact lost or added: the cross-model review listed facts absent on each side of every page; both lists empty, three rounds.
Proof
Probe: findings 3, 7, 2, 5 on the four pages, now 0 each; headings byte-identical before and after.
Tests:bun test test/docs 383 green; every added link resolves to an existing heading.
Technical details
Line accounting: docs +119 -26, nothing else; prose grew because paragraphs became lists and a table.
Kept local on purpose: the "GitHub hides the resource rather than admit it exists" reason behind a 404, the write-grade token clause for bypass_actors, and "delivery touches only its report issue, marker label, or encrypted artifact", since no owner page states them.
Reviewer note (Copilot): the generated regions on check-mode.md are untouched; heading text is frozen because other pages link to the anchors.
…, and troubleshooting pages for skimming
Every paragraph and list item over the 70-word cap, and every paragraph over three sentences, moved into the device that shows its content fastest: a result-and-exit table in check-mode, bold lead-in bullets for the redaction effects, the report-channel rules, the quiet-variant caveats, the canonical snapshot order, and the 403 and debug-trace facts, numbered steps for the bundle rebuild, and split paragraphs elsewhere. Headings and their anchors are unchanged on all four pages.
Five facts owned by docs/reference/permissions.md (the warn policy, the preflight probe's active-section rule, the 404-for-Administration rule, the hidden bypass_actors field, the GITHUB_TOKEN limitation) and one owned by private-repositories.md (what the private-report channels write in check mode) are now a link to the owner's heading with one local clause where the symptom needs it. No fact was lost or added; a cross-model review compared the old and new pages fact by fact and found both lists empty on every page.
The Exit behavior table's section-error row carried prose in its result cell where every other row carries the output value. The cell now reads `failed`, and the fact that the section itself is marked failed moved into the Outcome cell, so nothing is lost.
Report failure when warned denial accompanies another section error
docs/operate/check-mode.md:20
This row reports the wrong outcome when a warned denial is accompanied by another section error. For example, one skipped 403 plus one non-permission API error and no drift produces failed with exit 1, not partial with exit 0. Require that nothing else is failing as well.
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
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.
Before
After
How
Proof
bun test test/docs383 green; every added link resolves to an existing heading.Technical details
docs/operate/{check-mode,private-repositories,snapshot,troubleshooting}.md.