diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 50a7573fd3..d059058e3f 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -73,6 +73,7 @@ const guideSidebar = [ { text: 'CI', link: '/guide/ci' }, { text: 'Commit Hooks', link: '/guide/commit-hooks' }, { text: 'Monorepo Guide', link: '/guide/monorepo' }, + { text: 'Coding Agents', link: '/guide/coding-agents' }, { text: 'Troubleshooting', link: '/guide/troubleshooting' }, ], }, diff --git a/docs/guide/coding-agents.md b/docs/guide/coding-agents.md new file mode 100644 index 0000000000..d73f47bf9b --- /dev/null +++ b/docs/guide/coding-agents.md @@ -0,0 +1,127 @@ +# Coding Agents + +This page is a compact command guide for AI coding agents and humans directing them. Read this before automating Vite+ workflows so arguments are sent to the right command and validation uses the Vite+ command surface. + +## Quick Rules + +- Run `vp help` and `vp help ` before guessing command syntax. +- Prefer non-interactive flags in automated runs, such as `--no-interactive`, when a command supports them. +- Keep Vite+ command options before `--`; put template or underlying-tool options after `--` only where the command documents forwarding. +- Prefer `vp check` for local validation loops because it runs the configured format, lint, and type-check workflow together. +- Use `vp run ` for project scripts. Do not call package-manager scripts directly unless you specifically need package-manager behavior. + +## Forwarding Arguments + +`--` separates Vite+ options from options that should be forwarded to another tool. The most common case is `vp create