You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The repo currently documents plugin authoring, workflow, and release basics, but not the full tap contract or how DDPlugins functions as both the default NVIDIA tap and a reference tap repo. This issue turns the contracts from the other issues into maintainer-facing and consumer-facing docs.
Documentation changes
Add or update these docs:
docs/taps.md
Defines tap discovery vs runtime entry-point discovery.
Adds the new tap docs page to navigation outside the generated plugin docs block.
Acceptance criteria
A consumer can find the default NVIDIA tap URL and understand every schema v2 field.
Docs explain that the tap artifact is raw JSON, not an HTML page or docs-only artifact.
A maintainer can understand when to regenerate catalog/docs/CODEOWNERS and which files are generated.
An external author can understand how to configure a copied/forked tap repo, scaffold a plugin, publish a raw JSON catalog, and tell users how to add that tap once DataDesigner supports it.
Release docs explain how a plugin becomes discoverable and installable through the tap.
Docs distinguish tap discovery from runtime entry-point discovery.
Parent epic: #15
Depends on: #16, #18, #19, #20, #21, #22, #24
Why
The repo currently documents plugin authoring, workflow, and release basics, but not the full tap contract or how DDPlugins functions as both the default NVIDIA tap and a reference tap repo. This issue turns the contracts from the other issues into maintainer-facing and consumer-facing docs.
Documentation changes
Add or update these docs:
docs/taps.mdhttps://raw.githubusercontent.com/NVIDIA-NeMo/DataDesignerPlugins/main/catalog/plugins.jsonmainURL and tag/SHA pinned alternatives.README.mddocs/taps.md.docs/authoring.mdddp new --type column-generator|seed-reader|processoronce Extend ddp new to scaffold all DataDesigner plugin types #22 lands.[tool.ddp.tap], scaffold plugin, runmake all, publish raw JSON catalog.docs/workflow.mdcatalog/plugins.jsonis the machine-readable tap artifact.make catalogand validate withmake check-catalog/make check.docs/releasing.md{package}/v{version}.source.packageandpackage.version.repository-git-url, release ref, andpackage.pathas subdirectory.zensical.tomlAcceptance criteria
make docspasses in strict mode.Dependencies
DD-CLI-TAPS.