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/agents/_example/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 KiB
Raw Blame History

Example Agent Profile DOX

Purpose

  • Own the reference profile used to demonstrate bundled profile layout.
  • Show how profile-local prompts, tools, and extensions fit beside agent.yaml.

Ownership

  • agent.yaml owns the example profile metadata.
  • prompts/ owns prompt override examples.
  • tools/ owns profile-local tool examples.
  • extensions/ owns profile-local lifecycle extension examples.

Local Contracts

  • Keep this profile generic, minimal, and safe to copy into user or plugin profile work.
  • Do not add product behavior here that should live in a real bundled profile.
  • Profile-local tools and extensions must follow the same contracts as root tools and extensions.

Work Guidance

  • Prefer simple examples that illustrate structure over complex behavior.
  • Update related skill guidance when the example profile layout changes.

Verification

  • Manually inspect YAML and prompt filenames after edits.
  • Run profile-loading tests when changing discovery or profile schema assumptions.

Child DOX Index

No child DOX files.