vrr/agent-zero
2
0
Fork 0
mirror of https://github.com/agent0ai/agent-zero.git synced 2026-07-10 17:38:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
agent-zero/plugins/_editor/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

860 B
Raw Permalink Blame History

Editor Plugin DOX

Purpose

  • Own the native Markdown editor surface for canvas and floating modal workflows.

Ownership

  • api/ owns editor session and WebSocket handlers.
  • helpers/ owns markdown session and open-file context helpers.
  • prompts/ owns agent-visible open-file context.
  • webui/ owns editor panel, preview, store, and main surface.
  • extensions/ owns editor hook contributions.

Local Contracts

  • Keep editor session state synchronized across API, WebSocket, and WebUI panel behavior.
  • Do not expose unsaved content or local paths beyond intended chat/context surfaces.

Work Guidance

  • Coordinate editor preview and session changes with canvas surface registration.

Verification

  • Smoke-test opening, editing, previewing, and reconnecting editor sessions after changes.

Child DOX Index

No child DOX files.