docs-audit
Create an audit skeleton against a named specification
When to use it
Create an audit skeleton against a named specification. Use this when you want to add the corresponding files or task to your workspace.
Usage
npm exec -- nx generate @megamono/plugin:docs-audit --target="<target>" --project="<project>" --spec="<spec>" --dry-runReplace angle-bracket placeholders with reviewed values. Nx's --dry-run previews generator writes; remove it only after reviewing the plan. Examples use npm; use your workspace's package manager if it differs.
Options
Use these options with @megamono/plugin:docs-audit. Nx uses the camelCase names shown here; the CLI reference describes command-line aliases. Some options are required only for particular choices.
| Option | Required | Type | Default | Description |
|---|---|---|---|---|
target | Yes | string | — | What target is being audited? |
project | Yes | string | — | Which project owns the audited target? |
spec | Yes | string | — | Which spec ID is the audit standard? |
title | No | string | — | — |
topics | No | array | ["testing"] | — |
references | No | array | [] | — |
externalReferences | No | array | [] | — |
date | No | string | — | — |
Next steps
Review changed files and run the affected project's checks. For options that accept structured values, run the generator's --help or consult the schema in the installed package.
