README.md

Open Flow documentation

This directory contains current product boundaries, technical contracts, usage guides, and deployment references. For the product overview and quick start, see the project README (Simplified Chinese).

Product and technical contracts

• Product and architecture boundaries
• Control API reference
• Public contracts and version evolution
• Node compatibility runtime contract
• Command distribution and invocation

Flow authoring and node development

• Public node read and edit contract
• Node authoring development guide
• CLI Lab verification guide

Connections and permissions

• Flow authorization model
• Trigger permissions and execution

Trigger guides

• Flow Error
• Linear Issue Trigger

Server and deployment

• Server container delivery
• MCP integration
• Users, login, and permissions
• Docker images (GHCR) (Simplified Chinese)
• Fly.io deployment (Simplified Chinese)
• Run Open Flow with OpenConnector and the oo CLI (Simplified Chinese)

Development and documentation maintenance

• Contributing
• Development principles and verification requirements
• Workbench and Designer frontend guidance
• Lab Story development

The architecture document owns product boundaries and runtime invariants. Technical references own exact fields and protocols. Usage and deployment guides belong in their respective topic directories. README.<locale>.md files translate the project README. assets/ stores its images. Use Git history to trace implementation plans, migrations, and verification records. Historical tasks do not establish current capabilities or completed verification.