1.7 KiB
1.7 KiB
AGENTS.md
Guidance for AI coding agents and automated contributors working on this project.
Project Summary
Checkpoint is a minimal Astro-based personal homepage.
The site is:
- single-page
- mostly static
- intentionally lightweight
- designed to be easy to understand and easy to modify
This project is AI-friendly and was mostly created with AI assistance.
Goals
When making changes, preserve these core goals:
- keep the site fast
- keep JavaScript minimal
- keep the codebase small and readable
- keep the design dark, minimal, and modern
- prefer simple Astro components over adding frameworks
Preferred Tech Choices
- Astro only
- no React or Vue unless explicitly requested
- plain CSS preferred
- minimal dependencies
Editing Guidance
- Update link and hero content in
src/data/links.ts - Keep reusable UI in
src/components/ - Keep page structure in
src/pages/index.astro - Keep shared document structure and metadata in
src/layouts/Layout.astro - Keep styling centralized in
src/styles/global.css
Design Constraints
- dark background
- subtle hover effects
- responsive layout
- semantic HTML
- accessible focus states
Avoid overengineering. Do not turn this into:
- a portfolio
- a dashboard
- a SPA
- a framework-heavy app
Dependency Rules
Before adding a dependency, prefer:
- Astro built-ins
- plain HTML/CSS
- a very small library only if clearly justified
Content Rules
- Keep copy short
- Keep the homepage scannable
- Prefer data-driven updates over hardcoding repeated card markup
- Preserve the current structure unless a change is requested
Verification
When possible, verify changes with:
pnpm install
pnpm run build
If local tooling is unavailable, explain the limitation clearly.