# ZoneGaze Matrix

ZoneGaze Matrix is the host application and plugin platform for a combined local-first workspace.
The product is not a single subsystem. Matrix provides the shell, lifecycle, platform packaging,
shared contracts, and plugin composition layer; the user-facing functionality comes from the mix of
installed plugins such as Flow, Chat, Whispr, Joplin, Git, Code, Research, Social Studio, Open
Design, and Exo.

This repository still contains historical names such as the published `zonegaze-flow` CLI package,
the `flow/` workspace folder, and legacy deep-link/runtime labels. Those names are implementation
history, not the product boundary: the top-level product is ZoneGaze Matrix.

## Start Here

- [Master documentation index](docs/MASTER.md)
- [ZoneGaze Matrix overview](docs/product/zonegaze-matrix.md)
- [ZoneGaze Matrix manual](docs/manual/zonegaze-matrix-manual.md)
- [Business docs](docs/business/README.md)
- [Marketing positioning](docs/business/marketing-positioning.md)
- [Sales playbook](docs/business/sales-playbook.md)
- [Plugin catalog](docs/plugins/README.md)
- [Plugin coordination guide](docs/plugins/plugin-coordination.md)
- [Codebase guide](docs/codebase/README.md)
- [Reference hub](docs/reference/README.md)

## Product Map

- Matrix shell: dashboard, ports, plugin marketplace, settings, window/layout shell, platform
  lifecycle, and install/open state.
- First-party plugins: Flow, Chat, Whispr, Joplin, Git, ZoneGaze Code, ZoneGaze Research, and
  ZoneGaze Social Studio.
- Upstream-mounted plugins: Open Design and Exo.
- Shared foundations: contracts, common plugin services, runtime boundaries, platform bridges, and
  generated reference docs.

## Repository Map

- `docs/`: stable human-written docs and generated reference indexes.
- `plugins/`: plugin packages and upstream source mirrors owned by each plugin boundary.
- `flow/`: historical workspace name that contains shared web/runtime/contracts foundations plus
  the Flow plugin implementation.
- `platforms/`: Matrix host shells and packaging for desktop, Android, and related runtime helpers.
- `zonegaze/memory/`: durable project memory and agent operating-model guidance.

## Important Reading Paths

- Users: [manual](docs/manual/README.md), [platform guides](docs/platforms/README.md),
  [troubleshooting](docs/user/troubleshooting.md).
- Contributors: [developer onboarding](docs/developer/onboarding.md), [codebase guide](docs/codebase/README.md),
  [architecture index](docs/architecture/README.md).
- Plugin work: [plugins catalog](docs/plugins/README.md), [Matrix plugin architecture](docs/architecture/matrix-plugin-architecture.md),
  [plugins package index](plugins/README.md).

## Flow-Specific Note

ZoneGaze Flow remains an important first-party plugin and a published CLI/runtime surface. Its
plugin-level docs still live in the existing Flow manuals, feature guides, runtime reference, and
generated inventory:

- [Flow manual](docs/manual/software-manual.md)
- [Flow feature catalog](docs/features/feature-catalog.md)
- [Flow runtime API](docs/reference/runtime-api.md)
