shancheas
ff6814d038
- Introduced coding standards for TypeScript and React in SKILL.md. - Added continuous learning skill with configuration and evaluation scripts. - Created detail layout guidelines for read-only pages. - Established form layout rules for data-entry forms. - Documented project guidelines for the frontend monorepo. - Implemented security review checklist for frontend/Electron applications. - Developed a verification loop skill for comprehensive session checks. This commit enhances the skill set available for developers, ensuring adherence to best practices and improving code quality.
23 lines
921 B
Markdown
23 lines
921 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).
|