shancheas
f2f0be111a
- Added .cursor/sessions/* to .gitignore to prevent session files from being tracked. - Enhanced coding standards in SKILL.md by adding semicolons to TypeScript examples for consistency. - Improved formatting in continuous learning, detail layout, and other SKILL.md files for better readability. These changes aim to streamline development processes and maintain code quality across the project.
26 lines
924 B
Markdown
26 lines
924 B
Markdown
# Update Documentation
|
|
|
|
Sync docs with this frontend monorepo. Source of truth: `package.json`, `apps/web/.env.example`, and `apps/docs-dev` (VitePress).
|
|
|
|
1. Read root `package.json` scripts
|
|
|
|
- Table of `pnpm dev:web`, `pnpm dev:showcase`, `pnpm dev:docs-dev`, `pnpm typecheck:web`, `pnpm test`, `pnpm check:all`
|
|
|
|
2. Read `apps/web/.env.example`
|
|
|
|
- Document each `VITE_*` var (they are public to the client)
|
|
|
|
3. Update `apps/docs-dev` (VitePress) and the root README
|
|
|
|
- Where to work (`apps/web` vs `showcase`)
|
|
- Module layout (`example/full-page`)
|
|
- Preferred `@repo/*` imports
|
|
|
|
4. Do **not** generate `docs/CONTRIB.md` / `docs/RUNBOOK.md` unless those files already exist. This repo's docs app is `apps/docs-dev`.
|
|
|
|
5. List docs not modified in 90+ days for manual review
|
|
|
|
6. Show a diff summary
|
|
|
|
Single source of truth: `package.json`, `apps/web/.env.example`, `apps/docs-dev`, `apps/showcase` (API shape).
|