docs-research
Create an active research record
When to use it
Create an active research record. Use this when you want to add the corresponding files or task to your workspace.
Usage
bash
npm exec -- nx generate @megamono/plugin:docs-research --title="<title>" --project="<project>" --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-research. 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 |
|---|---|---|---|---|
title | Yes | string | — | What is being researched? |
project | Yes | string | — | Which project does this research affect? |
topics | No | array | ["architecture"] | — |
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.
