Skip to content

docs: link package contents to package.json and fix unpackaged links #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
altaywtf merged 4 commits into from
Sep 27, 2026
Merged

docs: link package contents to package.json and fix unpackaged links #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6d61ae7
docs: link screenshot limits and package contents to their sources
altaywtf Sep 27, 2026
dff5f1a
docs: point the skill at describe instead of unpackaged source
altaywtf Sep 27, 2026
4a2a112
docs: keep screenshot limits in the packaged README
altaywtf Sep 27, 2026
7dbcb68
docs: link the packaged package.json relatively
altaywtf Sep 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,13 +114,11 @@ traversal, backslashes, control characters, and percent-encoded path segments.
Generated output paths must stay within the current working directory.
Screenshots append a timestamp to the requested filename and report the actual
path written, so repeated captures do not reuse cache-prone filenames.
Captures reject non-JPEG/PNG responses and detected framing or decoding errors.
JPEG scan completion and restart order are checked before saving.
Captures accept up to 64 MiB of compressed data and 8,847,360 pixels (including
3840×2160 UHD and 4096×2160 DCI 4K); JPEG decoding has a 256 MiB memory limit.
PNG width and height are each limited to 8192 to bound decoder row allocations;
decompression is bounded by the declared pixel dimensions. Original image
bytes are preserved. Detected image errors use the normal capture retry path.
Captures are decoded and checked before saving, then written as the original
bytes. Limits: 64 MiB compressed, 8,847,360 pixels (4096×2160 DCI 4K fits),
8192 px per PNG side, and 256 MiB of JPEG decoder memory. Non-JPEG/PNG
responses, framing or decoding errors, and images over a limit go through the
normal capture retry path and fail if they persist.

## Library Use

Expand Down
16 changes: 8 additions & 8 deletions docs/DISTRIBUTION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Merges to `main` are considered publishable. The CI workflow runs:
1. `verify` on pull requests and `main` pushes.
2. semantic-release on `main` after `verify` passes.

semantic-release analyzes conventional commits, publishes to npm, creates GitHub Releases, and writes release metadata when needed.
semantic-release analyzes Conventional Commits; a releasable commit publishes to npm, creates a GitHub Release, and commits the released `package.json` version back to `main` with `[skip ci]`.

The release job calls the [shared frontend release workflow](https://github.com/putdotio/.github) from `putdotio/.github`, pinned to a tagged commit; the semantic-release action and plugin pins live there. [`scan.yml`](../.github/workflows/scan.yml) calls the shared frontend scan workflow from the same repository: Gitleaks, TruffleHog, Actionlint, and Zizmor on pull requests, weekly, and on manual dispatch.
The release job calls the [shared frontend release workflow](https://github.com/putdotio/.github) from `putdotio/.github`, pinned to a tagged commit; the semantic-release action and plugin pins live there. [`scan.yml`](https://github.com/putdotio/rokit/blob/main/.github/workflows/scan.yml) calls the shared frontend scan workflow from the same repository: Gitleaks, TruffleHog, Actionlint, and Zizmor on pull requests, weekly, and on manual dispatch.

## Release Credentials

Expand All @@ -30,11 +30,11 @@ Release writes use the `putio-releaser` installation token. The default `GITHUB_

## Package Contents

The npm package includes `dist`, `README.md`, `docs`, `examples`, `skills`,
`AGENTS.md`, `CONTRIBUTING.md`, and `SECURITY.md`. The docs, consumer skill, and
generic live probe are included so agents consuming the package can inspect
distribution, security, and generic Roku proof mechanics without cloning extra
private context.
`files` in [`package.json`](../package.json)
lists what the npm package ships. It carries the docs, consumer skill, and
generic live probe so agents consuming the package can inspect distribution,
security, and Roku proof mechanics without cloning the repository. Packaged docs
link files outside the tarball by absolute GitHub URL.

The published dependencies pin Effect, platform-node, and platform-node-shared to
the same prerelease. Keep those pins aligned: a consumer does not inherit this
Expand All @@ -58,7 +58,7 @@ gh release list --repo putdotio/rokit --limit 5
npm view @putdotio/rokit version
```

Live Roku behavior is not required for npm release. Real-device checks are local/manual because they require a developer-enabled Roku:
Releases do not need a Roku. Real-device checks stay local because they require a developer-enabled device:

```bash
ROKIT_TARGET=<roku-ip> pnpm live:smoke
Expand Down
4 changes: 2 additions & 2 deletions skills/rokit/references/live-proof.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ rokit describe proof
```

Use `README.md` for the public command overview. Use the one-command form to
keep context small when you already know the command family. Use `src/cli.ts`
when command behavior and docs disagree.
keep context small when you already know the command family. When the docs and
`rokit describe` disagree, trust `describe`.

## Quick Reads

Expand Down