Skip to content

Document plugin tap workflows#35

Merged
eric-tramel merged 1 commit into
codex/epic-15-plugin-tapfrom
codex/issue-25-final-docs
May 7, 2026
Merged

Document plugin tap workflows#35
eric-tramel merged 1 commit into
codex/epic-15-plugin-tapfrom
codex/issue-25-final-docs

Conversation

@eric-tramel

@eric-tramel eric-tramel commented May 7, 2026

Copy link
Copy Markdown
Contributor

What

Adds a dedicated docs/taps.md overview for Data Designer plugin taps, including the default NVIDIA raw catalog URL, schema v2 example and required fields, source object variants, raw JSON delivery expectations, trust guidance, external tap setup, and maintainer regeneration rules.

Updates README, authoring, workflow, releasing, schema reference, docs index, and Zensical navigation so tap discovery, generated catalog ownership, and release/install behavior are documented in the right places.

Why

Consumers need one place to find the default NVIDIA tap URL and understand that the tap is a raw schema v2 JSON catalog, not GitHub Pages or an HTML docs artifact. Maintainers and external tap authors also need clear guidance on which repo metadata feeds catalog entries, when generated files must be refreshed, and how a released package becomes discoverable and installable through a tap.

Usage

Default NVIDIA tap catalog:

https://raw.githubusercontent.com/NVIDIA-NeMo/DataDesignerPlugins/main/catalog/plugins.json

External tap authoring flow:

make sync
uv run ddp new my-plugin --type column-generator
make all

Publish the generated catalog/plugins.json as raw JSON at the configured [tool.ddp.tap].catalog-url. Once Data Designer supports tap configuration, users should add that raw catalog URL through the plugins taps add flow before discovering or installing plugins from the non-default tap.

How

  • Added docs/taps.md as the workflow-oriented tap page and linked it from README, docs index, and zensical.toml outside the generated plugin docs block.
  • Kept docs/tap-catalog-schema-v2.md as the detailed schema reference and moved workflow/trust emphasis to the new taps page to avoid repeating the same governance content in multiple places.
  • Expanded docs/authoring.md to describe ddp new --type column-generator|seed-reader|processor, catalog field inputs, [tool.ddp.tap], generated outputs, and external tap publishing.
  • Expanded docs/workflow.md and docs/releasing.md with raw catalog artifact handling, generated-file validation, per-plugin release tags, PyPI/Git source install derivation, multi-plugin package releases, and strengthened release validation coverage.

Validation

  • make sync
  • make docs
  • make check
  • git diff --check
  • make all

@eric-tramel eric-tramel requested a review from a team as a code owner May 7, 2026 20:07
@eric-tramel eric-tramel merged commit 0c37854 into codex/epic-15-plugin-tap May 7, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant