From a58b9dc551b60c0d3009920e43e831f87725b474 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lie=20DELHAIE?= Date: Sat, 18 Apr 2026 22:15:23 +0200 Subject: [PATCH] about AI --- AGENTS.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 4 +++ 2 files changed, 86 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..f5dcfbd --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,82 @@ +# 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: + +1. Astro built-ins +2. plain HTML/CSS +3. 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: + +```bash +pnpm install +pnpm run build +``` + +If local tooling is unavailable, explain the limitation clearly. diff --git a/README.md b/README.md index b7b1c6a..67bcf8a 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ A minimal personal homepage built with Astro. +This project is AI-friendly and was mostly created with AI assistance, then refined as a lightweight, maintainable Astro site. + This project is a lightweight public hub for: - a self-hosted Gitea instance @@ -84,6 +86,8 @@ Update this file to change: - The page is fully static and optimized for minimal client-side JavaScript. - Icons are provided through Font Awesome brand icons. - Styling is handled in `src/styles/global.css`. +- Content is primarily configured through `src/data/links.ts` to stay easy for both humans and AI agents to edit. +- Contributor guidance for AI/code agents lives in `AGENTS.md`. ## License