mirror of
https://github.com/prdlk/prdlk.git
synced 2026-11-03 05:27:41 +00:00
docs(docs): add AGENTS documentation and README files
This commit is contained in:
1 parent
bff9f9f999
commit
8a191f65cc
8 files changed
+364
-42
No files matched your search
@@ -0,0 +1,26 @@
|
||||
<!-- Parent: ../AGENTS.md -->
|
||||
<!-- Generated: 2026-06-30 | Updated: 2026-06-30 -->
|
||||
|
||||
# layouts
|
||||
|
||||
## Purpose
|
||||
Page shells that wrap route content with `<head>`, header, footer, and theming.
|
||||
|
||||
## Key Files
|
||||
| File | Description |
|
||||
|------|-------------|
|
||||
| `Base.astro` | Root shell for all pages. Renders `BaseHead`, `ThemeProvider`, `Header`, `<main class="mb-20">`, `Footer`, and prefetch speculation rules. Takes a `meta: SiteMeta` prop; `description` defaults to `siteConfig.description`. Sets `max-w-3xl`, `font-mono`, padding. |
|
||||
| `BlogPost.astro` | Layout for individual writing entries. Renders `Masthead`, optional `TOC`, the prose body, webmentions, and a back-to-top button. Builds the OG image URL as `/og-image/${post.id}.png`. |
|
||||
|
||||
## For AI Agents
|
||||
|
||||
### Working In This Directory
|
||||
- Every page should render inside `Base.astro` (directly or via `BlogPost.astro`) and pass a `meta` object (`title` required; `description`, `ogImage`, `articleDate` optional).
|
||||
- `<main>` carries `mb-20` to separate content from the footer's top border — adjust here for global content/footer spacing.
|
||||
|
||||
## Dependencies
|
||||
|
||||
### Internal
|
||||
- `@/components/BaseHead.astro`, `@/components/layout/*`, `@/components/blog/*`, `@/site.config`, `@/types`.
|
||||
|
||||
<!-- MANUAL: -->
|
||||
Reference in new issue
Block a user