mirror of
https://github.com/agent0ai/agent-zero.git
synced 2026-07-09 17:08:29 +00:00
Add comprehensive file-level DOX documentation across the repo and update directory AGENTS.md indexes. Many new `*.py.dox.md` files were added under api, helpers, tools, plugins, extensions, webui, and other dirs to document endpoint purpose, ownership, runtime contracts, work guidance, and verification. Several AGENTS.md files were created or updated (agents profiles, api, docker, extensions, helpers, plugins, skills, webui components, etc.) to list child DOX files and clarify documentation/work guidance. Also add example and bundled profile DOX files (agent0, default, developer, hacker, researcher) and minor updates to helpers/dirty_json.py and its tests. These changes improve on-disk documentation coverage and establish the convention that each direct runtime file should have a matching `*.dox.md` describing its contracts and verification steps.
992 B
992 B
Plugin Validator DOX
Purpose
- Own structured validation of Agent Zero plugins against manifest, structure, code-pattern, and security conventions.
Ownership
helpers/prompt.pyowns validation prompt construction.api/owns ZIP preparation, queue, start, and synchronous run endpoints.webui/owns validation checks, guidance, prompt template, store, UI, and thumbnail.plugin.yamlandREADME.mdown metadata and behavior notes.
Local Contracts
- Keep validation criteria aligned with
plugins/AGENTS.md, WebUI contracts, and Plugin Index requirements. - Temporary validation source directories and contexts must be cleaned up as intended.
- Do not confuse runtime
plugin.yamlwith Plugin Indexindex.yaml.
Work Guidance
- Coordinate checklist changes with prompt builder and frontend check selection.
Verification
- Smoke-test local, Git, and ZIP validation paths when API or prompt behavior changes.
Child DOX Index
No child DOX files.