mirror of
https://github.com/agent0ai/agent-zero.git
synced 2026-06-01 22:50:29 +00:00
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.
1.2 KiB
1.2 KiB
Scripts DOX
Purpose
- Own maintainer and automation scripts that live outside GitHub workflow directories.
- Keep scripts deterministic, documented by nearby callers, and safe to run in clean checkouts.
Ownership
openrouter_release_notes_system_prompt.mdis consumed by.github/scripts/docker_release_plan.py.- Additional repository maintenance scripts belong here when they are not runtime application code.
Local Contracts
- Do not commit secrets, generated credentials, private release notes, or local machine paths.
- Scripts used by CI must have stable inputs and fail with actionable errors.
- Keep script behavior synchronized with
.github/AGENTS.md, workflow YAML, and tests.
Work Guidance
- Prefer standard library Python or simple shell-compatible assets unless a dependency already exists for the script's runtime.
- Keep prompts and automation inputs concise and version-controlled.
- Update callers when renaming or moving scripts.
Verification
- Run targeted tests for any automation script with coverage.
- For release-note prompt changes, inspect generated output format expectations in
.github/scripts/docker_release_plan.py.
Child DOX Index
No child DOX files.