mirror of
https://github.com/agent0ai/agent-zero.git
synced 2026-07-09 17:08: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.
27 lines
650 B
Markdown
27 lines
650 B
Markdown
# Banner Extensions DOX
|
|
|
|
## Purpose
|
|
|
|
- Own backend banner and discovery-card contributions.
|
|
|
|
## Ownership
|
|
|
|
- Ordered Python files append alert banners or discovery cards to the mutable `banners` list.
|
|
|
|
## Local Contracts
|
|
|
|
- Banner IDs must be unique and stable.
|
|
- Use supported banner/card fields and types only.
|
|
- Do not expose secrets, local paths, or raw system diagnostics in banner text.
|
|
|
|
## Work Guidance
|
|
|
|
- Gate setup or warning banners on current configuration/status where possible.
|
|
|
|
## Verification
|
|
|
|
- Smoke-test welcome-screen banner rendering, ordering, dismissal, and CTA behavior after changes.
|
|
|
|
## Child DOX Index
|
|
|
|
No child DOX files.
|