Skip to content

[Plugins] Tutorial and reference docs for plugin authors and consumers #1075

Closed

Description

@tamirdresher

Part of #1068.

Scope

Author an end-to-end tutorial and reference documentation for the plugin system.

Requirements

  • Tutorial walks a new author through: scaffold a plugin -> write a manifest -> validate -> dry-run -> install into a sample Squad project -> enable -> switch -> uninstall.
  • Tutorial completes in under 30 minutes for someone already familiar with Squad.
  • Reference docs cover:
    • plugin.manifest.json schema (every field, required/optional, examples).
    • Install request format.
    • plugin.lock.json format.
    • Full squad plugin CLI surface.
    • Security posture: what the installer will and will not do.
    • Versioning policy (SemVer + prerelease channels).
  • All commands in the tutorial are exercised by a CI smoke test so the docs cannot silently rot.

Acceptance

  • Tutorial published under the docs site / docs directory.
  • Reference docs published and linked from the epic.
  • CI smoke test runs the tutorial commands end-to-end.

Planning provenance: tamirdresher_microsoft/tamresearch1#2926.

Activity

  1. bradygaster commented on Sep 23, 2026

    @bradygaster
    Collaborator

    Closing as resolved — plugin author/consumer docs now exist at docs/src/content/docs/features/plugins.md, guide/building-extensions.md, and guide/extensibility.md, exercised by test/plugin-extensibility.test.ts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions