diff --git a/packages/cli/README.md b/packages/cli/README.md index fdde4d458331..715add6fc6ef 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -580,12 +580,13 @@ export default { }; ``` -| Field | Type | Purpose | -| ------------ | -------- | --------------------------------------------------------------------- | -| `components` | `string` | Directory holding the package's components and their `.doc.*` files. | -| `templates` | `string` | Directory holding the package's page/block templates. | -| `codemods` | `string` | Directory holding upgrade codemods run by `astryx upgrade`. | -| `issuesUrl` | `string` | Where "report an issue" links for this package's contributions point. | +| Field | Type | Purpose | +| ------------ | -------- | --------------------------------------------------------------------------------- | +| `components` | `string` | Directory holding the package's components and their `.doc.*` files. | +| `templates` | `string` | Directory holding the package's page/block templates. | +| `codemods` | `string` | Directory holding upgrade codemods run by `astryx upgrade`. | +| `docs` | `string` | Directory of reference docs; each `{topic}.doc.*` becomes a topic the CLI serves. | +| `issuesUrl` | `string` | Where "report an issue" links for this package's contributions point. | Every field is optional; declare only the roots the package ships. There is no factory: write a plain object, and annotate it with the `AstryxIntegration` type