docs: record registry install check and document the install steps #19

Merged
haylan merged 3 commits from docs/verify-registry-install into main 2026-10-03 19:02:25 +00:00
Showing only changes of commit 3a15c73e95 - Show all commits
+2 -2
View File
@@ -73,8 +73,8 @@ From `@opencode/schema` 2.0.22: a result is `{ url: string, title?: string, cont
## Follow-ups this implies ## Follow-ups this implies
- **Local installs need a root `index.js`.** Add `index.js` (`export { default } from "./dist/index.js"`) to the package and `files`, so a config entry pointing at an unpacked package directory works as well as an npm-name install. The release script stages `package.json` and `dist/` only and would need to include it. - Decided against a root `index.js`: local testing uses a drop-in shim (see the README), and the package is installed by name through the registry.
- Update the README and spec examples: no `~` paths, and a directory (not a file) for local `plugins` entries. - Done: README install section and examples corrected (no `~` paths, directories only for local entries).
- Optional: decide whether the generic user-facing error is acceptable, since our detailed messages are not surfaced. - Optional: decide whether the generic user-facing error is acceptable, since our detailed messages are not surfaced.
- Optional: remove the `PACKAGE_TOKEN` secret and run the release workflow once more to test the job-token fallback. - Optional: remove the `PACKAGE_TOKEN` secret and run the release workflow once more to test the job-token fallback.