docs: add CLAUDE.md, refresh AGENTS.md and dev docs - #56
Merged
Conversation
- Add CLAUDE.md that imports AGENTS.md (@AGENTS.md) so Claude Code picks up the project context, plus Claude-Code-specific notes (gh account switching, pre-push behavior, deploy=publish, public-repo hygiene). - AGENTS.md: correct Astro 5 -> 6, refresh article examples, document check:links, and add a Conventions & Gotchas section. - Drop stale references to the removed link-check.yml workflow in README.md and DEVELOPMENT.md; document that internal link checking now runs inside ci.yml via check:links (no third-party action). - Correct npm run ci description to include verify, build, check:links.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refreshes project documentation to match the current state and makes the agent context reachable by Claude Code.
Changes
CLAUDE.md— imports AGENTS.md via@AGENTS.md(Claude Code readsCLAUDE.md, notAGENTS.md, so the existing context was previously invisible to it). Adds a short Claude-Code-specific notes section:ghaccount switching, pre-push behavior, deploy=publish, public-repo hygiene. Single source of truth stays in AGENTS.md.AGENTS.md— corrected Astro 5 → 6, refreshed article examples to current content, documentedcheck:links, added a Conventions & Gotchas section (pre-push, deploy=publish, public repo, internal-only link checking).README.md/DEVELOPMENT.md— removed stale references to the deletedlink-check.ymlworkflow; documented that internal link checking now runs insideci.ymlvianpm run check:links(no third-party action). Corrected thenpm run cidescription to includeverify,build, andcheck:links.Why the
@import(not a symlink)Cross-platform (symlinks are fragile on Windows / some checkouts), explicit, and lets
CLAUDE.mdadd Claude-Code-only notes without polluting the tool-neutralAGENTS.md.Verification
Docs-only. Pre-push suite green (lint, type-check, content validation, unit tests, build).