docs: add frontend onboarding docs
All checks were successful
Deploy to Frontend Servers / deploy (push) Successful in 55s

This commit is contained in:
TerryM
2026-05-16 18:14:55 +08:00
parent 9ba50565cb
commit f59d1e8e2a
6 changed files with 405 additions and 0 deletions

View File

@@ -0,0 +1,62 @@
---
name: arkie-frontend-onboarding
description: Onboard an AI agent to the Arkie Library frontend repo. Use when starting work in this repository, checking branch/deploy rules, or refreshing project context before coding.
---
# Arkie Frontend Onboarding
Use this skill before making non-trivial changes in the Arkie Library frontend repo.
## 1. Read project context
Read these files in order:
1. `README.md`
2. `AGENTS.md`
3. `docs/workflow.md`
4. `docs/deploy.md` if the task touches deploy, CI, environment variables, or `main` branch pushes.
## 2. Check current git state
Run:
```bash
git status --short --branch
git branch --show-current
```
Rules:
- `main` is the production deploy branch.
- `terry-staging` is the staging/work branch.
- Do not commit or push unless Terry explicitly asks.
## 3. Recall memory
Search project memory for relevant context before decisions, especially for:
- branch/deploy workflow
- frontend conventions
- admin UI behavior
- TypeScript/format failures
- prior fixes touching the same files
## 4. Validate before finishing
For code changes, run:
```bash
npx tsc --noEmit
npm run format:check
```
Run `npm run build` when changes affect routes, config, build, deploy, env vars, or dependencies.
## 5. Report clearly
Summarize:
- files changed
- commands run and results
- current branch/status
- whether anything needs pull/push/deploy