Skip to content

docs(cli): replace removed agent-docs command with init --features agents#3209

Open
cixzhang wants to merge 1 commit into
mainfrom
navi/docs/fix-agent-docs-command
Open

docs(cli): replace removed agent-docs command with init --features agents#3209
cixzhang wants to merge 1 commit into
mainfrom
navi/docs/fix-agent-docs-command

Conversation

@cixzhang

Copy link
Copy Markdown
Contributor

What

The agent-docs CLI command was removed — it's now folded into init behind the --features agents flag. Several user-facing references still pointed at the old, non-existent command. This updates them all to the current syntax.

Changes

packages/cli/docs/working-with-ai.doc.mjs (Working with AI guide):

  • Quick Start "paste into your AI" snippet: npx astryx agent-docsnpx astryx init --features agents
  • Prose describing what the command generates
  • Manual per-agent options (--agent claude/cursor/codex)
  • Cursor user-rule install (--agent-docs-path)

packages/cli/src/commands/upgrade.mjs:

  • Fallback warning shown when agent docs can't be auto-updated during upgrade now suggests astryx init --features agents instead of the removed command.

The --agent and --agent-docs-path flags carried over to init unchanged, so only the base command changed. One reference in the guide ("Checking Your Setup") already used the correct init --features agents form — this brings the rest in line.

Notes

Docs/content-only change. No package behavior changes, so no changeset. The .doc.mjs is consumed by the docsite generator at build time; verified it imports and parses cleanly.

… agents`

The `agent-docs` command was folded into `init` behind the
`--features agents` flag, but the Working with AI guide and an
upgrade fallback hint still pointed users at the old command. Update
all user-facing references so the documented and suggested commands
actually exist.
@vercel

vercel Bot commented Jun 27, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
astryx Ready Ready Preview, Comment Jun 27, 2026 6:08pm

Request Review

@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Meta Open Source bot. label Jun 27, 2026
@github-actions

Copy link
Copy Markdown
Contributor

PR Analysis Report

📚 Storybook Preview

View Storybook for this PR
GitHub Pages may take up to a minute to hydrate after deploy.

🧪 Sandbox Preview

View Sandbox for this PR
GitHub Pages may take up to a minute to hydrate after deploy.

No new or modified components detected.

Bundle Size Summary

Package Size (ESM) Size (CJS) Gzipped
@astryxdesign/core N/A 4.6KB 0B

Accessibility Audit

Status: No accessibility violations detected.


Generated by PR Enrichment workflow | Storybook | Sandbox | View full report

github-actions Bot added a commit that referenced this pull request Jun 27, 2026
@cixzhang cixzhang enabled auto-merge (squash) June 27, 2026 23:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant