diff options
| author | Dawid Rycerz <dawid@rycerz.xyz> | 2026-02-08 19:40:20 +0100 |
|---|---|---|
| committer | Dawid Rycerz <dawid@rycerz.xyz> | 2026-02-08 19:40:20 +0100 |
| commit | d00d86e42659d1b3a86049a290cc64bca0a1b448 (patch) | |
| tree | bbfe82c519ccc3fea5009c826cf2caa696db1cd1 /AGENTS.md | |
| parent | 42e5d3728f1d31fa986f7eebbf8a8f93e3948a45 (diff) | |
chore: add repo setup and update privacy policy hosting
- Add CLAUDE.md, AGENTS.md for Claude Code configuration
- Update .gitignore with Claude Code entries
- Update polityka prywatnosci: Cloudflare Pages -> statichost.eu
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Diffstat (limited to 'AGENTS.md')
| -rw-r--r-- | AGENTS.md | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..391fef0 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,64 @@ +# AGENTS.md + +## Project Overview + +CustomWorks.pl — official website for CustomWorks, a professional car detailing, wrapping, and tuning shop. Built with Astro (static output), Tailwind CSS, and TypeScript. Hosted on statichost.eu. + +## Commands + +- `npm run dev` — Start dev server +- `npm run build` — Build for production (static output) +- `npm run preview` — Preview production build locally +- `npm run check` — Run all checks (astro, eslint, prettier) +- `npm run check:astro` — TypeScript/Astro diagnostics +- `npm run check:eslint` — Lint with ESLint +- `npm run check:prettier` — Check formatting with Prettier +- `npm run fix` — Auto-fix eslint + prettier issues +- `npm run fix:eslint` — Auto-fix ESLint issues +- `npm run fix:prettier` — Auto-fix Prettier formatting + +## Architecture + +- **Framework:** Astro 5 with static output +- **Styling:** Tailwind CSS 3 with `@tailwindcss/typography` +- **Content:** MDX for blog/content pages, YAML config at `src/config.yaml` +- **Icons:** `astro-icon` with Tabler + Flat Color Icons sets +- **Images:** Sharp for optimization, `unpic` for responsive images +- **Integrations:** sitemap, partytown (conditional), astro-compress, astro-embed +- **Custom vendor integration:** `vendor/integration` (astrowind-based) + +### Directory Structure + +``` +src/ +├── assets/ # Static assets (images, fonts) +├── components/ # Astro/UI components +├── content/ # Content collections (blog posts, etc.) +├── layouts/ # Page layouts (MarkdownLayout, etc.) +├── pages/ # File-based routing +├── utils/ # Utility functions (frontmatter plugins, etc.) +├── config.yaml # Site configuration +├── navigation.ts # Navigation structure +└── types.d.ts # TypeScript type definitions +``` + +### Path Alias + +`~` resolves to `./src` (configured in Vite). + +## Conventions + +- TypeScript throughout +- Prettier + ESLint for code quality +- Astro components use `.astro` extension +- Content pages use `.md` / `.mdx` +- Polish language site — content is in Polish + +## Commit Rules + +**IMPORTANT:** Before completing any task, you MUST run `/commit` to commit your changes. + +- Only commit files YOU modified in this session — never commit unrelated changes +- Use atomic commits with descriptive messages +- If there are no changes to commit, skip this step +- Do not push unless explicitly asked |
