Files
browser/openspec/changes/sync-implemented-docs-and-comments/proposal.md
T
2026-07-11 14:56:10 +08:00

1.6 KiB

Why

Recent implementation changes completed platform metrics, config write/file dispatch, plugin bridge execution, mediated AI invocation, artifact browser download, and log/artifact transport behavior, but several route catalogs, protocol notes, frontend contracts, and handler comments still describe those capabilities as gaps or deferred work. Those stale references make it harder to tell which features are actually missing and which are already implemented.

What Changes

  • Update documentation and handler comments so implemented APIs are described as implemented.
  • Preserve explicit future-work boundaries for live external AI connectivity, remote model discovery, external storage adapters, browser upload, platform-to-run download, production throttling, server-side log filters, package acquisition, and remote plugin hosting.
  • Keep this change documentation-only; it does not add routes, runtime behavior, UI behavior, dependencies, or schema-breaking changes.

Capabilities

New Capabilities

  • implemented-documentation-sync: Keeps implementation-facing documentation and generated API comments aligned with completed platform/run/frontend/plugin capabilities.

Modified Capabilities

  • None.

Impact

  • Affected documentation and comments:
    • platform/api/routes.md
    • platform/protocol/ai-provider-contracts.md
    • run/protocol/artifact.md
    • platform_web/api/contracts.md
    • plugins/README.md
    • Swagger comments in platform/api/resource_handlers.go
  • No API, DTO, service, repository, frontend runtime, plugin SDK, or run executor behavior changes.