Migrate committed CLAUDE.md to AGENTS.md + gitignored CLAUDE.local.md - #36
Merged
Conversation
CLAUDE.md's content is now AGENTS.md's content (AGENTS.md is natively read by Claude Code, so no CLAUDE.md stub is needed for tooling discovery). Updates every consumer that referenced CLAUDE.md by name so nothing silently breaks: the Starlight reference-page generator (site/scripts/generate-reference-pages.mjs), the docs-deploy trigger path, the docs-freshness workflow's own description, and the prose mentions across README/CONTRIBUTING/SUPPORT/docs. CHANGELOG.md is left untouched as a historical record. Adds CLAUDE.local.md to .gitignore per the new convention. Closes #26
Contributor
There was a problem hiding this comment.
Pull request overview
Migrates the repo’s committed AI agent guidance from CLAUDE.md to AGENTS.md (per the org convention), updates in-repo consumers/documentation to reference AGENTS.md, and introduces a gitignored CLAUDE.local.md for session-local Claude memory.
Changes:
- Move durable agent documentation from
CLAUDE.mdintoAGENTS.md, and delete the committedCLAUDE.md. - Update scripts, workflows, and docs to reference
AGENTS.mdinstead ofCLAUDE.md. - Add
CLAUDE.local.mdto.gitignoreto support the new local-memory convention.
Reviewed changes
Copilot reviewed 13 out of 14 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| SUPPORT.md | Updates support documentation to reference AGENTS.md. |
| site/scripts/generate-reference-pages.mjs | Switches reference-page extraction source from CLAUDE.md to AGENTS.md. |
| README.md | Removes CLAUDE.md mentions and keeps agent-instruction references current. |
| docs/tutorials/first-project.md | Updates tutorial prose to point to AGENTS.md for design rationale. |
| docs/template/GITHUB-TEMPLATE-FEATURES.md | Updates template reference to describe AGENTS.md as the agent instructions source. |
| docs/template/CONFIGURATION.md | Consolidates assistant-instruction docs under AGENTS.md and updates customization guidance. |
| docs/template/CI-WORKFLOWS.md | Updates docs-deploy workflow trigger description to AGENTS.md. |
| docs/explanation/architecture.md | Updates architecture doc to reference AGENTS.md as the authoritative source. |
| CONTRIBUTING.md | Updates contributor guidance links from CLAUDE.md to AGENTS.md. |
| CLAUDE.md | Removes committed CLAUDE.md from the repository. |
| AGENTS.md | Becomes the single committed “durable” agent guidance file (expanded content). |
| .gitignore | Adds explicit ignore for CLAUDE.local.md. |
| .github/workflows/docs-freshness.md | Updates workflow documentation to reference AGENTS.md as the extraction source. |
| .github/workflows/docs-deploy.yml | Updates path trigger from CLAUDE.md to AGENTS.md. |
…location wording The generated site/src/content/docs/*.mdx pages were committed stale after the CLAUDE.md -> AGENTS.md source migration. Regenerate them via site/scripts/generate-all.mjs so they match the updated sources. Also aligns the GITHUB-TEMPLATE-FEATURES.md "Agent instructions" row wording with the rest of the docs, which consistently describe AGENTS.md as a repo-root file.
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
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.
Moves
CLAUDE.md's content intoAGENTS.mdperattested-delivery/CLAUDE.md§10, and removes the committedCLAUDE.md— no stub is kept since AGENTS.md is natively read by Claude Code, matchingattested-delivery/go-htmx's existing convention.This repo has real tooling wired to the
CLAUDE.mdfilename specifically, so a plain content move alone would have silently broken things. Updated every consumer instead of leaving them stale:site/scripts/generate-reference-pages.mjs— readsAGENTS.mdnow instead ofCLAUDE.md(verified locally: regenerates identical.mdxoutput)..github/workflows/docs-deploy.yml— path trigger changed fromCLAUDE.mdtoAGENTS.md..github/workflows/docs-freshness.md— source prose updated to describe the new mechanism (its compiled.lock.ymlstill lists bothAGENTS.mdandCLAUDE.mdin a genericgh-aw-provided agent-file constant, unrelated to this repo's actual files — recompiling would have pulled in an unrelatedgh-awversion bump, so it was left as-is).README.md,CONTRIBUTING.md,SUPPORT.md,docs/explanation/architecture.md,docs/template/CI-WORKFLOWS.md,docs/template/CONFIGURATION.md,docs/template/GITHUB-TEMPLATE-FEATURES.md,docs/tutorials/first-project.md.CHANGELOG.mdis left untouched — itsCLAUDE.mdmentions are historical record of past changes, not current-state documentation.Also adds
CLAUDE.local.mdto.gitignoreper the new convention (it wasn't covered by the existing*.localpattern, since it doesn't end in.local).Closes #26