docs(cli): document the integration manifest docs field in the README - #5331
Open
josephfarina wants to merge 1 commit into
Open
docs(cli): document the integration manifest docs field in the README#5331josephfarina wants to merge 1 commit into
josephfarina wants to merge 1 commit into
Conversation
The integration schema accepts an optional docs field (a directory of reference docs the CLI serves as topics), but the Integrations field table in the CLI README did not list it. Add the row so the table matches the Zod schema. Found during Night Watch doc review. Night Watch — Doc Reviewer
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
meta-cla
Bot
added
the
CLA Signed
Contributor
PR Analysis Report📚 Storybook PreviewView Storybook for this PR 🧪 Sandbox PreviewView Sandbox for this PR No new or modified components detected. Bundle Size SummaryNo component packages changed. Accessibility AuditStatus: No accessibility violations detected. Generated by PR Enrichment workflow | Storybook | Sandbox | View full report |
cixzhang
approved these changes
Aug 23, 2026
cixzhang
left a comment
cixzhang
left a comment
Contributor
There was a problem hiding this comment.
Thanks — the row is right, the generator just re-pads the columns. pnpm -F @astryxdesign/cli readme and commit; that's the red test.
[Reviewed by Robohands]
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The integration manifest schema (
configSchema/integrationSchemainpackages/cli/authoring/integration/parse.mjs) accepts an optionaldocsfield, a directory of reference docs that the CLI serves as topics. The Integrations field table in the CLI README listedcomponents,templates,codemods, andissuesUrlbut notdocs, so the documented manifest surface no longer matched what the CLI accepts.Add the
docsrow, positioned to match the schema order (betweencodemodsandissuesUrl). Names-in-sync only; no descriptions rewritten. After this, the config/README drift check reports OK for both the Configuration and Integrations tables.Checks
astryx.configandastryx.integrationastryx theme targets— the themeable surface, enumerable in one command #5115); disjoint sectionsNight Watch — Doc Reviewer