From f4ffc862e66889fcbcb4cbe77a8512c89a059697 Mon Sep 17 00:00:00 2001 From: Prad Nukala Date: Wed, 19 Aug 2026 14:12:45 -0400 Subject: [PATCH] docs(docs): add documentation for public assets directory --- public/AGENTS.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 public/AGENTS.md diff --git a/public/AGENTS.md b/public/AGENTS.md new file mode 100644 index 0000000..b894044 --- /dev/null +++ b/public/AGENTS.md @@ -0,0 +1,22 @@ + + + +# public + +## Purpose +Static assets copied verbatim to the site root at build time (served at `/`). + +## Key Files +| File | Description | +|------|-------------| +| `avatar.png` | Personal avatar used as the header logo (`src/components/layout/Header.astro`, referenced as `/avatar.png`) and in the homepage `Person` JSON-LD. | +| `icon.svg` | Source icon; `astro-webmanifest` generates favicons / apple-touch / manifest icons from it at build (referenced in `BaseHead.astro`). | +| `social-card.png` | Default Open Graph image when a page/post supplies no `ogImage`. | + +## For AI Agents + +### Working In This Directory +- Reference these with absolute root paths (`/avatar.png`), not the `@/` alias — they are not processed by Astro's asset pipeline. +- Replacing `icon.svg` changes all generated favicons/manifest icons; keep it roughly square (build warns otherwise). + +