photocraft/book/src

PhotoCraft Documentation

PhotoCraft is a native image editor written in Rust. This book is the maintained entry point for installation, architecture, formats, automation, development, and security documentation.

The repository's existing docs/ directory remains authoritative for detailed design notes, parity reports, UI conventions, release procedures, and the complete control-protocol method reference. The book links to those documents instead of copying them.

Start here

• Users and evaluators: Installation
• Contributors: Building and Contributing
• Architecture work: Architecture overview
• Agents and automation clients: Automation overview
• Security-sensitive work: Security overview and Threat model

Documentation for coding agents

Coding agents should read the following in order:

1. AGENTS.md for repository rules and verification gates.
2. README.md for product scope and current entry points.
3. book/src/architecture/ for crate boundaries and command flow.
4. book/src/automation/ before driving the CLI, control protocol, or MCP server.
5. book/src/security/ before changing a parser, file I/O, automation, MCP, the control server, command execution, or serialization/deserialization.

Agents must treat document bytes, paths, command parameters, and automation messages as untrusted input. A page that describes a proposed control does not mean that control is implemented.

Status language

Security pages use four labels consistently:

• Implemented: behavior confirmed in current source or tests.
• Known limitation: an exposed risk or missing control in current source.
• Proposed: a design direction that is not enforced by the current build.
• Future hardening: useful follow-up work without an accepted implementation yet.