README.md

DeepEye Documentation

This directory collects architecture notes, operational guidance, UI references, and remediation tracking for DeepEye.

Start Here

• Local quickstart
• Open-source remediation checklist
• Security model
• Release process
• Maintainer guide
• Dependency management
• Agent module
• Workflow node system
• Sandbox system
• Panel system

Architecture RFCs

• Workflow-native agent refactor
• Artifact protocol
• Maintainability refactor plan

UI References

• UI mockups
• Workspace assistant data icons
• Report progress panel icons
• Dashboard progress panel icons

Test And Demo Notes

• Test docs
• Retail ops workflow sample
• Knowledge base demo checklist

Documentation Expectations

When changing setup, architecture, API behavior, runtime boundaries, or security-sensitive flows, update the relevant docs in the same pull request.