# ZenNotes Docs

This directory documents ZenNotes as it exists today: one shared product core, an Electron desktop app, and a self-hosted web app backed by a Go server.

The docs are organized using the Diataxis model:

- `tutorials/`: guided walkthroughs for first-time users
- `how-to/`: task-focused guides for common workflows
- `reference/`: factual descriptions of settings, vault layout, and runtime boundaries
- `explanation/`: design and architecture documents that explain why ZenNotes works the way it does

## Start here

If you are new to ZenNotes, read these first:

- [Get Started on Desktop](./tutorials/get-started-desktop.md)
- [Use ZenNotes with Raycast on macOS](./how-to/use-raycast.md)
- [Self-Host with Docker](./how-to/self-host-with-docker.md)
- [Connect Desktop to a Remote ZenNotes Server](./how-to/connect-desktop-to-remote-server.md)

## Tutorials

- [Get Started on Desktop](./tutorials/get-started-desktop.md)

## How-to guides

- [Open Markdown Files with ZenNotes](./how-to/open-markdown-files.md)
- [Self-Host with Docker](./how-to/self-host-with-docker.md)
- [Use ZenNotes with Raycast on macOS](./how-to/use-raycast.md)
- [Connect Desktop to a Remote ZenNotes Server](./how-to/connect-desktop-to-remote-server.md)
- [Secure Self-Hosting](./how-to/secure-self-hosting.md)
- [At-Rest Encryption](./how-to/at-rest-encryption.md)

## Reference

- [Settings Reference](./reference/settings-reference.md)
- [Tasks Reference](./reference/tasks-reference.md)
- [Vault and Folder Model](./reference/vault-and-folder-model.md)
- [Runtime and Package Map](./reference/runtime-and-package-map.md)
- [Security Reference](./reference/security-reference.md)

## Explanation

- [How ZenNotes Works](./explanation/how-zennotes-works.md)
- [Security Model](./explanation/security-model.md)
- [Team Collaboration Plan](./explanation/team-collaboration-plan.md) (proposed — not yet implemented)
- [Monorepo Architecture](./monorepo-architecture.md)
- [Web Architecture](./web-architecture.md)

## Which document should I read?

Read a tutorial if you want a guided first success.

Read a how-to guide if you already know what you want to do and need the shortest path to doing it.

Read a reference doc if you want an exact description of a setting, runtime, or vault rule.

Read an explanation doc if you want to understand the architecture, design tradeoffs, or why the app behaves the way it does.
