voidzero-dev / voidzero-dev/vite-plus

docs: add a coding-agent guide for Vite+ command usage

Aperta
#1,537 0 commenti 1 reazione 0 assegnatari Vedi su GitHub
Lingua principale
Rust
Stelle
5.8k
Fork
262
Merge medio
23h 41m
PR unite (30g)
138

Descrizione

## Summary

Follow up on recent AI-assisted Vite+ usage: we should document more clearly how coding agents should invoke Vite+ commands, especially when forwarding args to scaffolding/templates.

## Problem

We saw an AI workflow pass extra args to Vite+ incorrectly.

Today the docs mention `vp create -- ` and include a few migration-agent notes, but there is no single page we can point coding agents to for Vite+ command conventions and common gotchas.

## Proposed docs work

- Add a dedicated docs page for coding agents / AI-assisted Vite+ workflows
- Explain when to use `--` to forward args to templates or underlying tools
- Show a few canonical examples, e.g.:
- `vp create vite -- --template react-ts`
- other representative forwarding cases if we support them
- Call out common mistakes explicitly (for example: passing template args directly to `vp create` without `--`)
- Link to this page from the existing create/migrate/agent-related docs so Codex and other agents have an obvious source of truth

## Acceptance criteria

- A dedicated docs page exists and is linked from the relevant Vite+ docs
- The page includes concrete command examples and a short “common mistakes” section
- The guidance is clear enough that we can point coding agents to it directly

## Notes

This is intended as a docs follow-up, not a product behavior change.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia leggendo la documentazione esistente di Vite+ relativa a create, migrate e agli argomenti correlati agli agenti, per confermare le convenzioni attuali dei comandi e il comportamento di inoltro. Aggiungi una guida dedicata ai coding agent con esempi canonici, una sezione sugli errori comuni e collegamenti dalla documentazione pertinente; il lavoro è completato quando i criteri di accettazione sono coperti e le indicazioni sono abbastanza chiare da poter essere condivise direttamente con gli agenti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
react, typescript
Ambito
cli, documentation, tooling
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Tranquilla
Chiarezza
Specificata chiaramente
Idoneità per principianti
72/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.