docs(plugins): consolidate guides and document npm publishing

This commit is contained in:
Mohamed Boudra
2026-09-17 09:17:39 +02:00
parent 8c4b7e5f79
commit 7e4f9ecf36
31 changed files with 561 additions and 1680 deletions
@@ -20,7 +20,7 @@ The callback receives the request after earlier plugins have transformed it. The
preserve their settings; the explicit values replace only the named fields. Paseo validates and saves
the resulting configuration before starting the agent. Existing agents are unchanged.
See the [lifecycle reference](../../public-docs/plugins/v0.8/reference.md#lifecycle-hooks) for ordering
See the [lifecycle reference](../../public-docs/plugins/reference.md#lifecycle-hooks) for ordering
and callback shapes. [Lifecycle actions](../lifecycle-actions) demonstrates provider switching and
environment injection. Its provider-switch callback clears provider options when changing Codex to
Claude, so use these examples separately when trying the Codex-specific settings.
+2 -2
View File
@@ -24,8 +24,8 @@ The example contributes one header button at a time. Additional actions live und
The client entry owns the active example. [client/examples.tsx](client/examples.tsx) contains the
descriptors, updates, and React content. Return `.remove()` cleanup when the example moves or stops.
See the [button reference](../../public-docs/plugins/v0.8/reference.md#button-descriptor) and
[composer migration](../../public-docs/plugins/v0.8/migration.md#composer-pills).
See the [button reference](../../public-docs/plugins/reference.md#button-descriptor) and
[composer migration](../../public-docs/plugins/migration.md#composer-pills).
From the repository root, `npm run typecheck --workspace=@getpaseo/plugin` checks this example
against the SDK. Existing plugin projects must update `@getpaseo/plugin` before running their own
+1 -1
View File
@@ -33,4 +33,4 @@ Claude agent.
See [agent configuration](../agent-configuration) for a focused example that injects MCP servers and
changes Codex sandbox and approval options while preserving other settings.
See the [lifecycle reference](../../public-docs/plugins/v0.8/reference.md#lifecycle-hooks) for the API.
See the [lifecycle reference](../../public-docs/plugins/reference.md#lifecycle-hooks) for the API.
+1 -1
View File
@@ -15,7 +15,7 @@ The same entries appear in the target daemon's `daemon.log`. The plugin log view
tail; use the daemon log for longer captures. Log lines are capped at 16 KiB, so a large timeline can
be truncated.
See the [lifecycle reference](../../public-docs/plugins/v0.8/reference.md#lifecycle-hooks) for callback
See the [lifecycle reference](../../public-docs/plugins/reference.md#lifecycle-hooks) for callback
shapes and delivery rules. The real-provider test in
`packages/server/src/server/plugins/lifecycle.real.e2e.test.ts` runs both examples on an isolated daemon
and saves evidence under `.dev/lifecycle-proof/`.
+2 -2
View File
@@ -18,12 +18,12 @@ The package ships the existing TypeScript entry and client sources. Paseo compil
its directory plugin loader; no package build or preparation command is required. React,
React Native, and `@getpaseo/plugin` are peer contracts supplied by the host. npm is needed for
installation, not loading or reloading. You can also install this directory while developing.
See the [source reference](https://paseo.sh/docs/plugins/v0.8/reference#plugin-sources)
See the [source reference](https://paseo.sh/docs/plugins/reference#plugin-sources)
for supported identifiers and preparation rules.
The examples demonstrate default and custom padding, a full-width body, author-owned ScrollView and
FlatList scrolling, horizontal tabs, and clipboard actions with a keyboard-aware input. See the
[host UI reference](https://paseo.sh/docs/plugins/v0.8/reference#host-ui) for the API contract.
[host UI reference](https://paseo.sh/docs/plugins/reference#host-ui) for the API contract.
The browser regression installs this exact example in an isolated daemon:
+1 -1
View File
@@ -2,7 +2,7 @@
"name": "@getpaseo/plugin-example-modal-ui",
"version": "0.1.1",
"description": "Interactive Paseo plugin example for modal forms, scrolling, and clipboard actions",
"homepage": "https://paseo.sh/docs/plugins/v0.8",
"homepage": "https://paseo.sh/docs/plugins",
"license": "Apache-2.0",
"repository": {
"type": "git",