mirror of
https://github.com/agent0ai/agent-zero.git
synced 2026-07-09 17:08:29 +00:00
175baa49db
Introduce DOX (AGENTS.md) contracts across the repository to formalize ownership and local work contracts: adds .github/AGENTS.md plus AGENTS.md files for agents, api, conf, docker, docs, extensions, helpers, knowledge, lib, plugins, prompts, scripts, skills, tests, tools, usr, webui (and several subfolders). Update root AGENTS.md (content and last-updated date) to include DOX framework guidance and a child DOX index. Update .gitignore to allow usr/ and usr/plugins AGENTS.md files. Remove legacy deep-dive files under docs/agents (banners, components, modals, plugins) and migrate frontend/plugin references to webui/ and plugins/ DOX locations. Also adjust plugins/README.md and several skills/*/SKILL.md files to align with the new DOX layout.
34 lines
1.3 KiB
Markdown
34 lines
1.3 KiB
Markdown
# Configuration Defaults DOX
|
|
|
|
## Purpose
|
|
|
|
- Own repository-shipped configuration defaults and templates.
|
|
- Keep clean-checkout defaults safe, portable, and free of user-specific state.
|
|
|
|
## Ownership
|
|
|
|
- `model_providers.yaml` defines built-in provider metadata and LiteLLM wiring defaults.
|
|
- `*.default.gitignore` files define templates copied or used for generated user/project/workdir directories.
|
|
- Runtime user settings belong under ignored `usr/` local state and are not documented with local DOX files.
|
|
|
|
## Local Contracts
|
|
|
|
- Do not commit API keys, provider secrets, local account identifiers, or private endpoints.
|
|
- Keep provider IDs and settings keys stable unless all loaders, UI references, migrations, and tests are updated.
|
|
- Defaults must work in a clean checkout and in Docker.
|
|
- Templates must avoid accidentally unignoring private runtime content.
|
|
|
|
## Work Guidance
|
|
|
|
- Prefer adding provider metadata here only when it is broadly useful to shipped Agent Zero.
|
|
- Keep comments concise and operational.
|
|
- Coordinate provider changes with model settings UI, plugin model overrides, and docs.
|
|
|
|
## Verification
|
|
|
|
- Run targeted model/provider tests after changing `model_providers.yaml`.
|
|
- Check generated ignore templates manually when changing `*.default.gitignore`.
|
|
|
|
## Child DOX Index
|
|
|
|
No child DOX files.
|