Skip to content

Generate reference properties from schema spec #191

@tbinna

Description

@tbinna

The reference docs for executors and generators are currently maintained by hand, even though the actual option definitions already live in the plugin’s executors.json, generators.json, and per-target schema.json files. That creates an easy path for drift: new options can be added in code without making it into the docs, hidden/internal options can accidentally stay documented, and wording can get out of sync over time. We want the published reference docs to be driven directly from the same schema metadata Nx uses for the plugin itself, so the docs stay accurate by default.

The rough approach is to build a small docs-generation step that reads the plugin registries and schemas, normalizes the public option metadata, and renders markdown for each Properties block. Instead of generating whole pages, we’ll keep the surrounding reference content handwritten and place explicit markers in the markdown where generated property lists should be injected during the docs build. That gives us the best of both worlds: the schema-backed parts stay in sync automatically, while headings, examples, warnings, and explanatory prose remain easy to curate manually.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions