Skip to content

docs(cli): plugin means two different things in os init -t plugin and os create plugin — disambiguate the word and fix the "Which scaffolder?" hint that sends plugin-skeleton readers to the wrong command (item 3 of #15531) #16484

Description

@os-zhuang

Filed by the director seat under the #15531 ruling (decision batch #66, 2026-09-07, option B).

The measured confusion

  • os init -t plugin scaffolds a metadata plugin (an ObjectStack package of metadata).
  • os create plugin scaffolds a kernel code plugin (TypeScript Plugin implementing init).
  • The docs' "Which scaffolder?" guidance sends a reader who wants a "plugin skeleton" to the wrong one.

Scope

  • Choose distinct wording for the two shapes in every user-facing string (command help, template names where cheap, docs pages), e.g. "metadata package" vs "code plugin"; ⛔ do not rename the CLI flags/subcommands here — that is a published-surface change and a separate decision if wanted.
  • Rewrite the "Which scaffolder?" hint as a two-question decision (metadata or code? new project or addition to an existing one?) that lands on os init, os init -t plugin, os create plugin, or npx create-objectstack unambiguously.
  • Keep the docs-parity pins green.

Acceptance

  • no page uses bare "plugin" for both shapes
  • the chooser names all four entry points with their purposes
  • skip-changeset (docs only) unless help strings change, then a patch changeset

Refs #15531.

Activity

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

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions