Skip to content

docs(cli): document the integration manifest docs field in the README #5331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cixzhang merged 2 commits into from
Aug 24, 2026
+7 −6
Merged

docs(cli): document the integration manifest docs field in the README #5331

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ea0926
docs(cli): document the integration manifest docs field in the README
josephfarina Aug 22, 2026
9aa08bb
docs(cli): regenerate README integration manifest table
cixzhang Aug 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions packages/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading