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.
829 B
829 B
Onboarding Plugin DOX
Purpose
- Own the built-in first-time onboarding wizard for model configuration.
Ownership
plugin.yamlowns metadata and always-enabled status.webui/owns onboarding providers, wizard store, modal/page markup, and thumbnail.
Local Contracts
- Keep onboarding provider choices synchronized with model configuration and provider metadata.
- Do not ask for or expose API keys outside approved settings/API flows.
- Avoid blocking already-configured users with unnecessary onboarding prompts.
Work Guidance
- Coordinate provider changes with
_model_configand_oauthwhen account-backed providers are involved.
Verification
- Smoke-test first-run onboarding, provider selection, completion, and skip/close behavior after changes.
Child DOX Index
No child DOX files.