docs: restructure AGENTS.md for parseability and single source of truth#594
Draft
docs: restructure AGENTS.md for parseability and single source of truth#594
Conversation
|
Hello, I'm the AEM Code Sync Bot and I will run some actions to deploy your branch and validate page speed.
Commits
|
Member
Author
|
Obviously needs to be road tested, so will remain in draft. |
shsteimer
added a commit
to cloudadoption/diyfire
that referenced
this pull request
Mar 5, 2026
Adopt the restructured format from adobe/aem-boilerplate#594 while preserving project-specific content (dark/light theme, dynamic blocks, shared.js utilities, Cloudflare Workers, templates, tools). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.
TL;DR: Restructures AGENTS.md to be clearer, non-duplicative, and easier for agents to follow. No functional changes.
Test URLs:
What's different (and why!)
AGENTS.md treated as a persistent instruction layer: Claude Code and similar agents load project instruction files at session start and retain them as persistent context across interactions. This makes AGENTS.md the most reliable location for durable behavioral rules and executable instructions. 1 2
Commands moved to the top: Agents process instruction files sequentially. Published guidance recommends putting executable commands first so agents encounter runnable instructions immediately rather than scanning prose. 3 4
Requirements consolidated into a single source of truth: Performance, accessibility, security, and testing requirements were merged into a single Requirements section. Guidance consistently recommends avoiding duplication and maintaining one authoritative location per rule to prevent conflicts and drift. 3 4 5
Explicit, discrete rules instead of bundled guidance: Multi-rule bullets were split into individual, imperative rules. This improves parseability and reduces ambiguity, which is specifically recommended for agent instruction files. 3 6
Reduced duplication and file size: Removed redundant explanations and consolidated overlapping sections. Instruction files are persistent context and benefit from being concise and unambiguous. 7 4
Standardized structure and predictable scan order: Sections and formatting were normalized so both mere mortals and agents can reliably locate commands, requirements, environments, and workflows. Real-world reference implementations follow similar structural conventions. 8 5
Alignment with Helix and David’s Model: The document explicitly reinforces intuitive authoring, clear author–developer contracts, and avoidance of hidden conventions consistent with Helix principles. 9 10
Impact
Documentation-only change. No functionality change or authoring impact.
References