Skip to content

docs: add comprehensive CLAUDE.md / AGENTS.md for the templates repo#1

Merged
reloru merged 4 commits into
mainfrom
claude/add-claude-documentation-3D8IU
May 21, 2026
Merged

docs: add comprehensive CLAUDE.md / AGENTS.md for the templates repo#1
reloru merged 4 commits into
mainfrom
claude/add-claude-documentation-3D8IU

Conversation

@reloru
Copy link
Copy Markdown
Owner

@reloru reloru commented May 20, 2026

Summary

  • Expands the root AGENTS.md (symlinked as CLAUDE.md) from a single-line redirect into a comprehensive AI-assistant reference
  • Covers repository layout, template variants (Node.js vs Cloudflare), dev workflow, key files in every template, EmDash conventions, template-specific notes, CI pipeline, available skills, and the docs MCP server

What's documented

  • Repo structure — all nine templates and what each one is for
  • Variants table — Node.js (SQLite + local FS) vs Cloudflare (D1 + R2), with adapter differences
  • Dev workflowpnpm installnpx emdash devpnpm typecheck / pnpm build
  • Key filesastro.config.mjs, seed/seed.json, emdash-env.d.ts, src/live.config.ts, Base.astro
  • EmDash conventions — server-rendering requirement, image field shape, dual entry IDs (entry.id vs entry.data.id), cache hints, taxonomy name matching, parallel queries, slug decoding
  • Template notes — blog features, marketing block plugin, portfolio, starter, blank
  • CI — typecheck + build + smoke test matrix, why Cloudflare variants skip the smoke test
  • Skills & docs MCP — how to load the right skill, where to find live documentation

Test plan

  • Read AGENTS.md / CLAUDE.md and confirm both reflect the new content (they are symlinked)
  • Verify no factual errors against astro.config.mjs, package.json, and seed/seed.json in a representative template

https://claude.ai/code/session_016pBD7iYqFuGuAMEjd5a93v


Generated by Claude Code

claude added 3 commits May 20, 2026 22:12
…ions

Expands the root AGENTS.md (symlinked as CLAUDE.md) from a single-line
redirect into a full reference covering template layout, variants, dev
workflow, key files, EmDash conventions, template-specific notes, CI,
available skills, and docs MCP server.

https://claude.ai/code/session_016pBD7iYqFuGuAMEjd5a93v
- Add account_id and database_id to wrangler.jsonc (required by wrangler)
  targeting existing crosbynews-db D1 and crosbynews-media R2 resources
- Add deploy-blog-cloudflare.yml workflow: builds and deploys on push to
  main when blog-cloudflare/ files change, also triggerable manually

Requires CLOUDFLARE_API_TOKEN secret to be added to the repo settings.

https://claude.ai/code/session_016pBD7iYqFuGuAMEjd5a93v
The package.json already defines "deploy": "astro build && wrangler deploy",
so there's no need for a separate build step in CI.

https://claude.ai/code/session_016pBD7iYqFuGuAMEjd5a93v
@reloru reloru marked this pull request as ready for review May 21, 2026 01:15
Combines account_id from feature branch with database_id from main.

https://claude.ai/code/session_016pBD7iYqFuGuAMEjd5a93v
@reloru reloru merged commit dcc589b into main May 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants