vrr/agent-zero
2
0
Fork 0
mirror of https://github.com/agent0ai/agent-zero.git synced 2026-07-09 17:08:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
agent-zero/docker/AGENTS.md
frdel e138e33ca9 Add file-level DOX docs & update AGENTS indexes 
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.
2026-06-08 12:41:53 +02:00

1.5 KiB
Raw Blame History

Docker DOX

Purpose

  • Own Docker build contexts and runtime container definitions.
  • Keep framework runtime, agent execution runtime, exposed ports, mounted paths, and image build assumptions explicit.

Ownership

  • base/ owns the base image context.
  • run/ owns the runnable image context and compose file.
  • Root DockerfileLocal is owned by the root contract but must stay compatible with this directory.

Local Contracts

  • Preserve the two-runtime model documented in the root contract: framework runtime under /opt/venv-a0 and agent execution runtime under /opt/venv.
  • Do not bake secrets, local .env values, or user data into images.
  • Keep compose mounts aligned with usr/, logs/, and other runtime-state expectations.
  • Image changes that affect GitHub publishing must stay synchronized with .github/workflows/docker-publish.yml.

Work Guidance

  • Keep Dockerfile steps cache-friendly and explicit about which runtime they target.
  • Avoid broad copies of ignored runtime folders.
  • Update setup docs when ports, volumes, startup commands, or runtime layout change.

Verification

  • Build the affected Docker context when Docker behavior changes.
  • Run Docker-related tests or startup smoke checks when changing runtime entrypoints.

Child DOX Index

Direct child DOX files:

Child Scope
base/AGENTS.md Base image Dockerfile, copied filesystem, and installation scripts.
run/AGENTS.md Runnable image Dockerfile, compose example, entrypoints, and install scripts.