Skip to content

docs(plugin): correct catalog migration guidance - #55657

Open
1052326311 wants to merge 1 commit into
anomalyco:devfrom
1052326311:issue-55628-docs
Open

1052326311 wants to merge 1 commit into
anomalyco:devfrom
1052326311:issue-55628-docs

Conversation

@1052326311

Copy link
Copy Markdown
Contributor

Issue for this PR

Closes #55628

Type of change

  • Bug fix
  • New feature
  • Refactor / code improvement
  • Documentation

What does this PR do?

Remove the nonexistent catalogs context domain from the V1 migration guide. Explain how the early V2 ctx.catalog transform and reload calls map to the current ctx.provider and ctx.model domains.

How did you verify your code works?

  • Read-only assertions checked the current Effect and Promise context types, Promise adapter wiring, historical catalog type, current provider/model editor methods, and the linked API heading. The local proof passed.
  • npm exec --yes [email protected] -- prettier --check services/www/src/docs/content/build/plugins/migrate-v1.mdx passed.
  • git diff --check passed.
  • Bun and repository dependencies are unavailable locally, so the full docs build, typecheck, and local server reproduction were not run. Hosted checks have not yet completed.

Screenshots / recordings

Not applicable; documentation text only.

Checklist

  • I have tested my changes locally
  • I have not included unrelated changes in this PR

@github-actions

Copy link
Copy Markdown
Contributor

The following comment was made by an LLM, it may be inaccurate:

@opencode-agent opencode-agent Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The docs fix looks correct. I checked the new migration paragraph against the current plugin types in packages/plugin/src/effect/provider.ts and model.ts and their Promise versions. ProviderEditor.update(providerID, fn), ModelEditor.update(providerID, modelID, fn) and transform/reload on both domains all exist. I also checked it against the published @opencode-ai/[email protected], whose v2/effect/catalog.d.ts defines the CatalogDraft.provider.update / model.update signatures the paragraph maps from. No other build docs still mention a catalog domain.

Public API: unchanged (documentation only).

No blocking concerns.

This branch has not been deployed

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: migrate-v1 lists a catalogs plugin context domain that does not exist

1 participant