1 authoring reference registry contributor extension contract
forgejo-actions edited this page 2026-07-15 12:43:13 +00:00

Authoring Reference Registry Contributor Extension Contract

Purpose

Reference-registry contributors let new content domains participate in autocomplete, reference health, usage search, and rename/delete migration plans. Use this contract when adding a new authored domain or reference kind.

Steps

  1. Declare contributor descriptors with source dependencies and capabilities.
  2. Register definition sources and reference sources.
  3. Add autocomplete provider IDs when authors need picker support.
  4. Mark typed catalog-backed references separately from diagnostic-only references.
  5. Wire rename/delete planner blockers and warnings before enabling migration actions.

Expected Outputs

A contributor should make definitions discoverable, usages explainable, autocomplete scoped, and migration previews complete. Typed catalog-backed references should route to concrete source records.

Common Mistakes

Common mistakes include adding autocomplete without migration coverage, reporting only definitions but not usages, treating diagnostic-only references as safe to rename automatically, or forgetting source dependencies.

Recovery Paths

When migration preview misses a usage, inspect contributor routes and typed catalog bindings. When autocomplete shows stale IDs, verify source dependency signatures and provider IDs.