Skip to content

Internal: Add developer documentation (DEVELOPERS.md, AGENTS.md, CLAUDE.md) [TMZ-1066] - #678

Merged
Ntnelbaba merged 1 commit into
mainfrom
TMZ-1066-add-developer-docs
Aug 6, 2026
Merged

Internal: Add developer documentation (DEVELOPERS.md, AGENTS.md, CLAUDE.md) [TMZ-1066]#678
Ntnelbaba merged 1 commit into
mainfrom
TMZ-1066-add-developer-docs

Conversation

@Ntnelbaba

@Ntnelbaba Ntnelbaba commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add DEVELOPERS.md — full developer guide covering local setup, running the theme via wp-env, debugging (PHP debug log, admin React UI, Xdebug), build/lint/test commands, architecture (Theme singleton + custom autoloader, module/component system, admin-home module, REST API, template dispatch, three-layer settings, asset enqueueing), conventions, and release/versioning notes.
  • Add AGENTS.md — mirror of DEVELOPERS.md for Cursor and other AI coding tools.
  • Add CLAUDE.md — points Claude Code to DEVELOPERS.md/AGENTS.md as the single source of truth.

Test plan

  • DEVELOPERS.md renders correctly and accurately describes setup, build/lint/test commands, debugging, and architecture.
  • AGENTS.md content matches DEVELOPERS.md.
  • CLAUDE.md references DEVELOPERS.md and AGENTS.md.
  • Documented commands (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 versioning
  • AGENTS.md & CLAUDE.md: Minimal entry points redirecting to DEVELOPERS.md for full guidance

3. How It Works

Documentation establishes a clear hierarchy: theme bootstrap via functions.phpTheme singleton → module system (Module_Base). Covers the admin-home React 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

@CLAassistant

CLAassistant commented Aug 6, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@Ntnelbaba
Ntnelbaba merged commit 2b87f50 into main Aug 6, 2026
21 checks passed
@Ntnelbaba
Ntnelbaba deleted the TMZ-1066-add-developer-docs branch August 6, 2026 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants