mirror of
https://github.com/agent0ai/agent-zero.git
synced 2026-07-10 01:18:29 +00:00
e138e33ca9
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.
29 lines
889 B
Markdown
29 lines
889 B
Markdown
# Python Function Extensions DOX
|
|
|
|
## Purpose
|
|
|
|
- Own implicit `@extensible` backend hook implementations.
|
|
- Preserve nested module, class/function, method, and `start`/`end` extension layout.
|
|
|
|
## Ownership
|
|
|
|
- Each nested path mirrors a Python module and qualname segment.
|
|
- Leaf `start/` and `end/` directories own ordered extension files for that extensible function point.
|
|
|
|
## Local Contracts
|
|
|
|
- Do not flatten nested qualname paths into retired legacy folder names.
|
|
- Extension functions must match the implicit hook's supplied arguments.
|
|
- Preserve ordering prefixes where exception handling, watchdog registration, or cleanup depends on them.
|
|
|
|
## Work Guidance
|
|
|
|
- Keep implicit hook extensions narrow and colocated with the exact function point they extend.
|
|
|
|
## Verification
|
|
|
|
- Run targeted tests for the affected function point after changes.
|
|
|
|
## Child DOX Index
|
|
|
|
No child DOX files.
|