Skip to content

docs(plugins): reconcile developer documentation with current contracts - #1890

Merged
vastsa merged 4 commits into
mainfrom
docs/plugin-development-sync-20261026
Oct 26, 2026
Merged

vastsa merged 4 commits into
mainfrom
docs/plugin-development-sync-20261026

Conversation

@vastsa

@vastsa vastsa commented Oct 26, 2026 •

Copy link
Copy Markdown
Owner

Plugin authoring references contained obsolete lifecycle, permission, packaging, UI, and publishing claims. Align the English and Chinese guides, plugin specifications, packaged authoring skill, and example index with the current SDK, installer, and runtime. The guide now indexes all 103 Host API methods and 45 permissions and calls out SDK/installer differences and unimplemented proposals.

Validation completed:

  • Locale pairs, all documentation pages, agent-policy sync, and the VitePress build pass.
  • 191 SDK, 52 devkit, 28 documentation/skill, and 87 host contract tests pass (358 total). Host tests use the current SDK source because the shared local build output was stale.
  • Both guides' JSON examples and SDK inventories were checked. Their minimal examples pass check/pack and the real plugin subprocess command/unload path; all four templates pass scaffold/check/pack.
  • No application runtime implementation or persisted contract changed; full application Electron E2E was not required for this documentation update.

Task candidate: e99605c48cd67fd3e783b737a65ba99249cb8b46
Base main: 79eae84a11550c8826025534a122a7bf8cc77b2d

The published branch incorporated the updated main through a non-destructive merge. Locale/page/policy checks, documentation/skill tests, SDK/example audits, and the VitePress build pass again on this candidate. The PR diff remains documentation-only.

Plugin authoring references had drifted from the SDK, installer, and
runtime, leaving obsolete permission, lifecycle, packaging, and UI claims.
Document the complete host surface and distinguish implemented capabilities
from proposals and independent publisher-service design.

Keep the English and Chinese guides, domain references, packaged authoring
skill, and example entry points aligned. Call out SDK/installer differences
so a successful authoring check is not mistaken for runtime compatibility.
Copilot AI balanced review requested due to automatic review settings October 26, 2026 07:43

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

Include the updated main baseline without rewriting the published documentation branch. This keeps the PR candidate current after the transcript repair landed while its checks were starting.
Keep the published documentation branch current with main before the final landing gate, preserving the existing branch history.
@vastsa
vastsa merged commit 850a267 into main Oct 26, 2026
3 checks passed
@vastsa
vastsa deleted the docs/plugin-development-sync-20261026 branch October 26, 2026 12:47

This branch was previously deployed

1 inactive deployment
Preview — 0ffc586d Deployed Oct 26, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants