docs: recover missing CLI docs + types for recently-merged security PRs#1019
Merged
Merged
Conversation
#981 (PERRY_SANDBOX_BUILDRS), #988 (--emit-attest), and #969 (perry.permissions) each landed via admin-bypass with their SUMMARY.md entries intact but without the actual .md content files (or, for #969, without any docs entry at all). docs/src/cli/lockdown.md and docs/src/cli/emit-sandbox.md did make it into main and are fine; the others left dead links. Separately, #976 / #972 / #974 added perry/system runtime methods (getOSVersion, shareText, shareUrl, appGroupSet/Get/Delete) but never updated the hand-maintained types/perry/system/index.d.ts. TypeScript users importing those APIs from `perry/system` get a type error today. This PR: - Creates docs/src/cli/sandbox-buildrs.md (#505) - Creates docs/src/cli/emit-attest.md (#504) - Creates docs/src/cli/capabilities.md (#501) and adds the SUMMARY.md entry - Adds the six new perry/system signatures to types/perry/system/index.d.ts The auto-generated docs/api/perry.d.ts + docs/src/api/reference.md were regenerated during the original PRs and are already current. Pure docs-only diff. No code changes.
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.
Three PRs that landed via admin-bypass today reference docs files
that don't actually exist in the tree, plus three perry/system PRs
that didn't update the hand-maintained `types/` file. This is the
docs follow-up.
What's missing
`docs/src/cli/lockdown.md` (#496) and `docs/src/cli/emit-sandbox.md`
(#506) did land in their respective PRs and are unaffected.
What this PR does
derived from each PR's description (workflow, opt-in mechanisms,
capability tokens, related-PR cross-references).
`types/perry/system/index.d.ts` with the same docstring style as
the surrounding entries.
Why not in the original PRs
Most of these PRs were rebased + admin-merged locally during today's
loop. The docs gaps were pre-existing in the PRs themselves (the
SUMMARY entries pointed at files that were never committed); the
`types/` gaps are the standard "manifest entry was added but the
hand-maintained types file wasn't touched" pattern.
The auto-generated `docs/api/perry.d.ts` + `docs/src/api/reference.md`
already cover the new symbols and are up to date on main.
Test plan
dispatch table in `crates/perry-dispatch/src/lib.rs` — signatures match.
Pure docs-only diff. No code changes.