Skip to content

Commit f42443e

Browse files
committed
Add AGENTS and CLAUDE project guidance docs
1 parent 9746bf7 commit f42443e

2 files changed

Lines changed: 58 additions & 0 deletions

File tree

AGENTS.MD

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# AGENTS.MD
2+
3+
## Project
4+
- Personal website for `marcopisco.com`
5+
- Stack: TypeScript + Vite + vanilla CSS
6+
- Entry point: `src/main.ts`
7+
- Styles: `src/styles.css`
8+
- Static assets: `public/`
9+
10+
## Local workflow
11+
- Install: `npm install`
12+
- Dev server: `npm run dev`
13+
- Type check + build: `npm run build`
14+
- Preview build: `npm run preview`
15+
16+
## Deployment
17+
- GitHub Pages deploy is automated by `.github/workflows/deploy-pages.yml`
18+
- Push to `main` triggers build and deploy
19+
- Domain is configured by `CNAME`
20+
21+
## Editing guidelines
22+
- Make focused, minimal diffs
23+
- Keep website responsive on desktop/mobile
24+
- Preserve existing Discord presence + writeups/posts behavior unless asked to change it
25+
- Prefer updating source files in `src/` and `public/`, not generated output in `dist/`
26+
27+
## Validation
28+
- Run `npx tsc --noEmit` for quick safety check
29+
- If build tooling is available, run `npm run build`
30+

CLAUDE.MD

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# CLAUDE.MD
2+
3+
## Context
4+
- This repository is a personal portfolio site.
5+
- Main runtime code lives in `src/main.ts`.
6+
- Main styling lives in `src/styles.css`.
7+
- Public assets and writeups live in `public/`.
8+
9+
## What to optimize for
10+
- Clean, direct implementation over overengineering
11+
- Strong visual consistency and responsive behavior
12+
- Fast iteration with small, reviewable commits
13+
14+
## Constraints
15+
- Do not break existing sections: Home, About, Skills, Experience, Education, Posts, Contact
16+
- Keep Discord presence integration working (Lanyard websocket flow in `src/main.ts`)
17+
- Keep posts loading from `public/writeups/index.json`
18+
- Avoid changing deployment workflow unless explicitly requested
19+
20+
## Commands
21+
- `npm run dev`
22+
- `npx tsc --noEmit`
23+
- `npm run build`
24+
25+
## Commit style
26+
- Use concise imperative commit messages
27+
- Commit only files related to the requested change
28+

0 commit comments

Comments
 (0)