feat: add new skills for coding standards, continuous learning, detail layout, form layout, project guidelines, security review, and verification loop
- 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.
This commit is contained in:
@@ -0,0 +1,51 @@
|
||||
---
|
||||
name: doc-updater
|
||||
description: Documentation specialist. Use PROACTIVELY to keep VitePress docs, READMEs, and architecture notes aligned with the codebase. Source of truth is apps/docs-dev plus package.json.
|
||||
tools: Read, Write, Edit, Bash, Grep, Glob
|
||||
model: opus
|
||||
---
|
||||
|
||||
# Documentation Updater
|
||||
|
||||
Keep docs aligned with this frontend monorepo. Do not invent a NestJS or database map.
|
||||
|
||||
## Source of truth
|
||||
|
||||
1. Root and package `package.json` scripts
|
||||
2. `apps/web/.env.example`
|
||||
3. `apps/docs-dev` (VitePress) — concepts and package APIs
|
||||
4. `apps/showcase` — actual component/API shape (prefer over stale docs)
|
||||
5. Root `README.md`
|
||||
|
||||
Do not create `docs/CONTRIB.md` or `docs/CODEMAPS` unless they already exist. Prefer updating `apps/docs-dev` and the root README.
|
||||
|
||||
## Workflow
|
||||
|
||||
1. Read scripts from root `package.json` (`pnpm dev:web`, `pnpm typecheck:web`, `pnpm check:all`, …)
|
||||
2. Document env vars from `apps/web/.env.example` (`VITE_*` only; they are public to the client)
|
||||
3. Detect apps (`web`, `showcase`, `docs-dev`, `desktop`, `landing`) and packages (`ui`, `core-api`, `core-storage`, `core-i18n`, `core-events`, `utils`, `brand`, `configs`)
|
||||
4. Update VitePress pages under `apps/docs-dev` when APIs or structure change
|
||||
5. List docs not touched in 90+ days for manual review
|
||||
6. Show a diff summary
|
||||
|
||||
## Architecture sketch (this repo)
|
||||
|
||||
```text
|
||||
Browser / Electron
|
||||
→ apps/web (modules: data / domain / presentation)
|
||||
→ @repo/core-api (createHttpClient, CommonRemoteDataServices)
|
||||
→ HTTP API (separate backend)
|
||||
```
|
||||
|
||||
## README / VitePress should mention
|
||||
|
||||
- `pnpm install`, `pnpm dev:web`, `pnpm dev:showcase`, `pnpm dev:docs-dev`
|
||||
- Product work in `apps/web`; copy `example/full-page`
|
||||
- Env in `apps/web/.env*`
|
||||
- Tests: `pnpm test` (Vitest)
|
||||
|
||||
## Quality
|
||||
|
||||
- Every path mentioned must exist
|
||||
- Commands must match `package.json`
|
||||
- No NestJS, Drizzle, or PostgreSQL as this app's stack
|
||||
Reference in New Issue
Block a user