Skip to content

docs: add AGENTS.md#1734

Merged
kpal81xd merged 2 commits intomainfrom
agents
Feb 10, 2026
Merged

docs: add AGENTS.md#1734
kpal81xd merged 2 commits intomainfrom
agents

Conversation

@kpal81xd
Copy link
Contributor

@kpal81xd kpal81xd commented Feb 10, 2026

Summary

  • Adds AGENTS.md documenting conventions, architecture, and best practices for AI agents and developers working on the editor frontend.
  • Covers project overview, page loading lifecycle, directory structure, the Caller pattern, editor-api module, build system, testing, code style, common patterns, and anti-patterns.

Details

This is a documentation-only change — no code modifications. The file serves as a reference for both human contributors and AI coding agents to understand how the editor is structured and how to make changes correctly.

@kpal81xd kpal81xd changed the title docs: add AGENTS.md for AI agent and developer guidelines docs: add AGENTS.md Feb 10, 2026
@kpal81xd kpal81xd self-assigned this Feb 10, 2026
@kpal81xd kpal81xd added the docs Improvements or additions to documentation label Feb 10, 2026
@kpal81xd kpal81xd requested a review from a team February 10, 2026 12:11
@willeastcott
Copy link
Contributor

My gut feeling is that this is needlessly wordy. AFAIK, your AGENTS.md is going to used up some of your context window. If we have a workspace referencing all or most of the PlayCanvas repos, all the AGENTS.md files are going to add up quickly. My approach is to get AI to write the skinniest AGENTS.md possible and then add to it whenever the LLM gets something wrong. See the developer-site one for an example:

https://github.com/playcanvas/developer-site/blob/main/AGENTS.md

@kpal81xd
Copy link
Contributor Author

My gut feeling is that this is needlessly wordy. AFAIK, your AGENTS.md is going to used up some of your context window. If we have a workspace referencing all or most of the PlayCanvas repos, all the AGENTS.md files are going to add up quickly. My approach is to get AI to write the skinniest AGENTS.md possible and then add to it whenever the LLM gets something wrong. See the developer-site one for an example:

https://github.com/playcanvas/developer-site/blob/main/AGENTS.md

Yep it is very long so im going to try condense it down

- Condensed project overview and guidelines for clarity.
- Updated section on editor loading and architecture, emphasizing backend rendering and module communication.
- Simplified directory structure and code style conventions for better readability.
@kpal81xd kpal81xd merged commit 8f93f2d into main Feb 10, 2026
3 checks passed
@kpal81xd kpal81xd deleted the agents branch February 10, 2026 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants