Docs: "Using Vite+" page, and the entries the repo's rules require

Open
  • Is something wrong?
#16 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
38/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
angular, typescript, vite
Domain
documentation

Research direction

Read CLAUDE.md, docs/decisions.md, and docs/design.md first, then inspect the referenced content files, site/src/app/docs.ts, and the repository’s current Vite+ migration spike for verified details. Run pnpm docs:check and pnpm site:build after writing; done means the new guide and all listed cross references, status, changelog, README, decisions, and design entries are complete and both commands pass.

Written by the indexing model from the issue text.

Description

documentation

Part of #13. Labels: documentation.

New page site/content/vite-plus.md, titled "Using Vite+", in the Guide section of DOCS in site/src/app/docs.ts, after Getting started. Written in Clarity style for one reader: an Angular developer who already has vp installed, or an existing plugin user who wants vp. Every command on the page is run before it's published; no number that wasn't measured.

Sections

  1. What Vite+ is, in one paragraph, and what it changes for an Angular app: one CLI (vp) that wraps Vite, Vitest, Oxlint, Oxfmt and tsdown, defineConfig from vite-plus, and vite as an alias of @voidzero-dev/vite-plus-core. Link to viteplus.dev; don't restate its docs.
  2. Create a new app: vp create @push-based/ngp my-app, what the prompts ask, what the generated project contains, the unattended form vp create @push-based/ngp -- --no-interactive --template app. Then vp dev, vp build, vp test, vp check.
  3. Move an existing app built with the plugin: vp migrate, exactly what it rewrote in the spike (scripts, vite/vitest pins to catalog:, imports to vite-plus and vite-plus/test, lazyPlugins, fmt/lint/staged blocks, AGENTS.md, .vite-hooks), and what to check afterwards. The vite alias requirement, stated once, with why.
  4. Move an ng build app: follow Migrating from ng build first, then section 3. What vp migrate leaves alone: angular.json, Husky (left with a warning), ng scripts.
  5. The toolchain with Angular: vp test (Vitest 5.1, vite-plus/test imports, the TestBed setup unchanged), vp check (Oxfmt defaults vs Angular's single quotes and how to set fmt.singleQuote; Oxlint on decorators and signals, no Angular-specific rules; tsgo type errors vs the plugin's template type-check), vp lint and .gitignore, vp staged, vpx for ngp-extract-i18n.
  6. Server rendering under Vite+: ngp({ssr: true}) with vp dev and vp build, the app-ssr template, running server.mjs with vp node or node.
  7. Limits: no row in vp create --list yet, peer warning on npm/yarn, Windows untested, vp pack (tsdown) is for libraries and the plugin doesn't build libraries, Nx workspaces not tried under vp.

Other files, per CLAUDE.md

  • site/content/getting-started.md: a two-line note at the top for Vite+ users pointing at the new page.
  • site/content/status.md: a "Vite+" row under What works, with what was checked and the alias caveat.
  • site/content/changelog.md: one line under the release date linking the page.
  • site/content/server-rendering.md and testing.md: one sentence each pointing at the Vite+ section that applies.
  • README.md: vp create @push-based/ngp next to the install snippet in Try it, and the new package in the "What's in this repo" table.
  • docs/decisions.md: an entry for the package name (@push-based/create-ngp, scoped like the plugin, and why there's no org-wide @push-based/create), the plain-Vite output, and the vite alias.
  • docs/design.md: a paragraph on what the template guarantees and where versions come from.
  • pnpm docs:check and pnpm site:build pass.
Dominant language
TypeScript
Stars
7
Forks
1
Avg merge
12h 24m
Merged PRs (30d)
13

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from push-based/vite-plugin-ngp

All issues in push-based/vite-plugin-ngp

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.