Skip to content

Commit 023e438

Browse files
committed
docs: trim implementation details and design rationale from create guide
Two inline review findings from @fengmk2 on PR #1398: - Bundled subdirectory section was leaking implementation details (tarball download mechanics, SHA-512 integrity verification, cache path under $VP_HOME, NPM_CONFIG_REGISTRY handling). Users just need to know that `./...` paths resolve against the @org/create package root and that the directory is copied verbatim. The rest belongs in the RFC. - Non-interactive inspection section explained the design rationale for keeping the output machine-parseable ("so scripts and AI agents can recover the list without a separate `--list` flag"). That's an RFC-level decision; users just need to see the shape of the output.
1 parent 9cb8102 commit 023e438

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/guide/create.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ An invalid manifest is a hard error, not a silent fall-through — a maintainer
181181

182182
### Bundled subdirectory templates
183183

184-
Relative `./...` paths resolve against the enclosing `@org/create` package root — **not** the user's cwd. Vite+ downloads the tarball once per published version (honoring `NPM_CONFIG_REGISTRY`), verifies its SHA-512 integrity against `dist.integrity`, and extracts it under `$VP_HOME/tmp/create-org/<scope>/<name>/<version>/`. Subsequent invocations reuse the cache. The referenced directory is copied verbatim no template-engine processing. Paths that escape the package root are rejected at schema-validation time.
184+
Relative `./...` paths resolve against the enclosing `@org/create` package root — **not** the user's cwd. The referenced directory is copied verbatim into the target project (no template-engine processing). Paths that escape the package root are rejected.
185185

186186
### Make the org the default in a repo
187187

@@ -201,7 +201,7 @@ The picker always appends a trailing **Vite+ built-in templates** entry so `vite
201201

202202
### Non-interactive inspection
203203

204-
`vp create @org --no-interactive` prints a stable, fixed-column table of the manifest (name, description, resolved template specifier) and exits 1. The output is machine-parseable, so scripts and AI agents can recover the list without a separate `--list` flag:
204+
`vp create @org --no-interactive` prints the manifest as a table and exits 1:
205205

206206
```
207207
A template name is required when running `vp create @your-org` in non-interactive mode.

0 commit comments

Comments
 (0)