Internal: Add developer documentation (DEVELOPERS.md, AGENTS.md, CLAUDE.md) [TMZ-1066] - #678
Merged
Merged
Conversation
…DE.md) [TMZ-1066]
max-zu
approved these changes
Aug 6, 2026
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.
Summary
DEVELOPERS.md— full developer guide covering local setup, running the theme viawp-env, debugging (PHP debug log, admin React UI, Xdebug), build/lint/test commands, architecture (Theme singleton + custom autoloader, module/component system,admin-homemodule, REST API, template dispatch, three-layer settings, asset enqueueing), conventions, and release/versioning notes.AGENTS.md— mirror ofDEVELOPERS.mdfor Cursor and other AI coding tools.CLAUDE.md— points Claude Code toDEVELOPERS.md/AGENTS.mdas the single source of truth.Test plan
DEVELOPERS.mdrenders correctly and accurately describes setup, build/lint/test commands, debugging, and architecture.AGENTS.mdcontent matchesDEVELOPERS.md.CLAUDE.mdreferencesDEVELOPERS.mdandAGENTS.md.npm run wp-env:start,npm start,npm run lint,composer run test) work as described.Jira
TMZ-1066
✨ PR Description
1. Problem & Context
Add comprehensive developer documentation to onboard contributors and standardize local development workflows. Centralizes setup, build, test, and architecture guidance in one source of truth.
2. What Changed (Where)
DEVELOPERS.md: 176-line guide covering prerequisites, local setup (wp-env), build/test commands, debugging, linting, architecture patterns, naming conventions, and versioningAGENTS.md&CLAUDE.md: Minimal entry points redirecting to DEVELOPERS.md for full guidance3. How It Works
Documentation establishes a clear hierarchy: theme bootstrap via
functions.php→Themesingleton → module system (Module_Base). Covers theadmin-homeReact module, REST API patterns, template dispatch, settings layers, and asset enqueueing. Includes concrete commands (npm run,composer run) and debugger setup (Xdebug on port 9003).4. Risks
None—documentation-only change. Accuracy depends on dev environment staying aligned with documented commands; nominate owner for periodic audits as tooling evolves.
Generated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using.
💡 Tip: You can customize your AI Description using Guidelines Learn how