Repository navigation
docs(reference): reshape the permissions, forward-compatibility, and secrets pages for skimming - #433
Merged
Merged
Conversation
…secrets pages for skimming Every paragraph over the 70-word cap on the three pages becomes the device that shows it fastest: split paragraphs, bullets with bold lead-ins, a denial-policy verdict table, a variables-vs-secrets table, and a table of the three sibling secret stores. The grant list, the org caveats, the strict nested shapes, the operator-authored sources, and the environment-secret rules are now lists. "Three things worth knowing" now says four, matching its bullets. No fact was lost or added: the cross-model review listed the facts absent on each side of every page, and both lists are empty after two rounds. Headings are byte-identical, the generated regions are untouched, semantics.md is unchanged, and the probe reports 0 findings per page (was 4, 4, 8).
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documentation-only restructuring preserves the existing semantics and valid references.
Review effort: Balanced
Findings: None
What changed in this PR
Reshapes three reference pages for faster scanning without changing documented behavior.
Changes:
- Splits dense prose into focused paragraphs and bullets.
- Adds concise permissions and secret-store tables.
- Preserves generated regions, headings, links, and existing facts.
| File | Description |
|---|---|
docs/reference/permissions.md |
Clarifies grants and denial policies. |
docs/reference/forward-compatibility.md |
Clarifies passthrough and strict shapes. |
docs/reference/secrets-and-vaults.md |
Clarifies secret handling and store behavior. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
File size check0 over a hard cap (fails), 34 warning(s).
Split the file, wrap the line, shorten or exempt the comment, or list the path in 5 managed file(s) skipped; repo-platform owns 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.
Before
After
How
Proof
bun test test/docs383 green; the one anchor in a rewritten unit resolves.Technical details
docs/reference/{permissions,forward-compatibility,secrets-and-vaults}.md.