diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..49c0586 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,201 @@ +# AGENTS.md + +This file provides guidelines for agentic coding agents working in this repository. + +## Tech Stack + +- **Framework**: Astro 5.7.3 - Static site generator +- **Styling**: Tailwind CSS 3.4.19 with custom theme +- **Package Manager**: pnpm 10.29.2 +- **TypeScript**: 5.9.3 with @astrojs/check +- **Icons**: FontAwesome 4.7.0 (CDN) + +## Build & Development Commands + +```bash +# Development +pnpm dev # Start dev server at http://localhost:4321 +pnpm start # Alias for pnpm dev + +# Build & Quality +pnpm build # Run astro check then build (production) +pnpm preview # Preview production build locally + +# Direct Astro commands +pnpm astro # Run any astro command directly +``` + +**Note**: No test framework is currently configured. When adding tests, first check with the maintainers. + +## Project Structure + +``` +src/ +├── layouts/Layout.astro # Main layout with navigation +├── pages/ # Route pages (use .astro files) +│ ├── index.astro # Home page +│ └── [route]/index.astro +├── components/ +│ └── sections/ # Reusable section components +└── styles/styles.css # Global styles +``` + +## Code Style Guidelines + +### Astro Components + +- File extension: `.astro` +- Frontmatter uses `---` delimiters +- Import components at the top of the frontmatter section +- Use TypeScript for type annotations in frontmatter and `