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/docs/AGENTS.md
Alessandro 91b3bc9613 Slim browser viewer frame transport 
Negotiate binary and slim screencast frames so updated clients avoid base64-in-JSON and repeated viewer metadata on every frame.

Clamp screencast capture to the subscriber viewport and DPR, lower streaming JPEG quality while preserving snapshot quality, and teach the client to manage binary frame URLs safely.

Document the browser viewer performance plan and update regression coverage for the new transport contract.
2026-07-03 01:49:07 +02:00

1.6 KiB
Raw Blame History

Documentation DOX

Purpose

  • Own human-facing documentation, screenshots, setup guides, developer guides, and documentation assets.
  • Keep docs accurate to current source behavior and practical user workflows.

Ownership

  • README.md, quickstart.md, guides/, and setup/ cover user-facing setup and workflows.
  • developer/ covers compact developer references and source handoffs.
  • plans/ covers implementation plans, migration notes, and staged technical roadmaps.
  • res/ contains documentation images and other documentation assets.

Local Contracts

  • Prefer local docs for practical workflows and direct users to DeepWiki for source-linked internals when appropriate.
  • Do not document secrets, private deployment details, unreleased credentials, or user-specific runtime state.
  • Screenshots and assets must be relevant to the documented UI state and should be updated when UI changes make them misleading.
  • Keep links relative inside the docs tree unless they intentionally point to external community or reference resources.

Work Guidance

  • Update docs in the same change when user-visible behavior, setup steps, settings names, plugin workflows, or UI labels change.
  • Keep user guides task-oriented and avoid duplicating architecture contracts already owned by source-adjacent DOX files.
  • When editing screenshots or binary assets, avoid unrelated metadata churn.

Verification

  • Check changed internal links manually or with an available link checker.
  • For setup or Docker docs, verify commands against current scripts and Docker files.

Child DOX Index

No child DOX files.