An open source design system that's fully customizable and agent ready
TypeScript
docs(cli): document the integration manifest docs field in the README (#5331)
Joey42468a9ccbae
diff --git a/packages/cli/README.md b/packages/cli/README.mdindex 7288d85ad6..58f6c5717e 100644--- a/packages/cli/README.md+++ b/packages/cli/README.md@@ -581,12 +581,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 nofactory: write a plain object, and annotate it with the `AstryxIntegration` type