# Paarrot documentation

Documentation for the Paarrot Matrix client (Cinny fork). Use this index to find feature handoffs, API references, and developer guides.

## Handoff docs (start here)

Per-feature handoff folders live under [`handoff/features/`](./handoff/features/). Each folder has a `HANDOFF.md` with architecture, key files, data model, and maintenance notes.

New feature? Copy [`handoff/TEMPLATE.md`](./handoff/TEMPLATE.md) into `handoff/features/<feature-name>/HANDOFF.md` and add a row below.

### Platform & shell

| Feature | Handoff |
|---------|---------|
| Electron desktop shell | [electron-shell](./handoff/features/electron-shell/HANDOFF.md) |
| Android (Capacitor/Tauri) | [android](./handoff/features/android/HANDOFF.md) |
| Client chrome (title bar, splash, welcome) | [client-chrome](./handoff/features/client-chrome/HANDOFF.md) |
| Local HTTP API | [local-api](./handoff/features/local-api/HANDOFF.md) |
| Stream Deck integration | [streamdeck](./handoff/features/streamdeck/HANDOFF.md) |
| Background notifications | [background-notifications](./handoff/features/background-notifications/HANDOFF.md) |

### Core client

| Feature | Handoff |
|---------|---------|
| Authentication | [authentication](./handoff/features/authentication/HANDOFF.md) |
| Matrix client (init, sync, providers) | [matrix-client](./handoff/features/matrix-client/HANDOFF.md) |
| State management (Jotai) | [state-management](./handoff/features/state-management/HANDOFF.md) |
| Routing & navigation | [routing-and-navigation](./handoff/features/routing-and-navigation/HANDOFF.md) |
| E2E encryption & devices | [e2e-and-devices](./handoff/features/e2e-and-devices/HANDOFF.md) |

### Navigation & panels

| Feature | Handoff |
|---------|---------|
| Home & sidebar | [home-and-sidebar](./handoff/features/home-and-sidebar/HANDOFF.md) |
| Room nav (channel rows) | [room-nav](./handoff/features/room-nav/HANDOFF.md) |
| Direct messages | [direct-messages](./handoff/features/direct-messages/HANDOFF.md) |
| Inbox & invites | [inbox-and-invites](./handoff/features/inbox-and-invites/HANDOFF.md) |
| Explore (public rooms) | [explore](./handoff/features/explore/HANDOFF.md) |
| Join before navigate | [join-before-navigate](./handoff/features/join-before-navigate/HANDOFF.md) |

### Messaging

| Feature | Handoff |
|---------|---------|
| Room timeline | [room-timeline](./handoff/features/room-timeline/HANDOFF.md) |
| Editor & composer | [editor-and-composer](./handoff/features/editor-and-composer/HANDOFF.md) |
| Message rendering (markdown, HTML) | [message-rendering](./handoff/features/message-rendering/HANDOFF.md) |
| Media & URL preview | [media-and-url-preview](./handoff/features/media-and-url-preview/HANDOFF.md) |
| Message search | [message-search](./handoff/features/message-search/HANDOFF.md) |
| Global search (quick nav) | [global-search](./handoff/features/global-search/HANDOFF.md) |

### Rooms, spaces & creation

| Feature | Handoff |
|---------|---------|
| Create flows (room/space/DM) | [create-flows](./handoff/features/create-flows/HANDOFF.md) |
| Room settings | [room-settings](./handoff/features/room-settings/HANDOFF.md) |
| Space settings | [space-settings](./handoff/features/space-settings/HANDOFF.md) |
| Common settings (shared pages) | [common-settings](./handoff/features/common-settings/HANDOFF.md) |
| Sub-rooms | [sub-rooms](./handoff/features/sub-rooms/HANDOFF.md) |
| Lobby (space card view) | [lobby-forums](./handoff/features/lobby-forums/HANDOFF.md) |
| Forum spaces (post feed UI) | [forum](./handoff/features/forum/HANDOFF.md) |

### Settings & customization

| Feature | Handoff |
|---------|---------|
| User settings | [user-settings](./handoff/features/user-settings/HANDOFF.md) |
| Themes & appearance | [themes-and-appearance](./handoff/features/themes-and-appearance/HANDOFF.md) |
| Emojis & stickers | [emoji-stickers](./handoff/features/emoji-stickers/HANDOFF.md) |
| Custom emoji packs | [custom-emoji-packs](./handoff/features/custom-emoji-packs/HANDOFF.md) |
| Avatar metadata | [avatar-metadata](./handoff/features/avatar-metadata/HANDOFF.md) |
| Embed filters | [embed-filters](./handoff/features/embed-filters/HANDOFF.md) |
| Developer tools | [developer-tools](./handoff/features/developer-tools/HANDOFF.md) |

### Real-time & extensions

| Feature | Handoff |
|---------|---------|
| Voice & video calls | [voice-calls](./handoff/features/voice-calls/HANDOFF.md) |
| Plugin system | [plugins](./handoff/features/plugins/HANDOFF.md) |

## API & plugin references

| Doc | Description |
|-----|-------------|
| [API.md](./API.md) | Full local HTTP API reference (port 33384) |
| [API-QUICKSTART.md](./API-QUICKSTART.md) | Quick start for the local API |
| [PLUGINS.md](./PLUGINS.md) | Plugin system user guide |
| [PLUGIN_API.md](./PLUGIN_API.md) | Full plugin API reference |
| [PLUGIN_BUTTON_API.md](./PLUGIN_BUTTON_API.md) | UI button injection API |
| [PLUGIN_SYSTEM_IMPLEMENTATION.md](./PLUGIN_SYSTEM_IMPLEMENTATION.md) | Internal plugin architecture |

Plugin development guide (in-app): [`src/app/features/settings/plugins/PLUGIN_DEVELOPMENT.md`](../src/app/features/settings/plugins/PLUGIN_DEVELOPMENT.md)

## Repo layout (docs-related)

```
cinny/docs/
  README.md                 ← you are here
  handoff/
    README.md               ← how to write handoff docs
    TEMPLATE.md             ← copy for new features
    features/
      <feature-name>/
        HANDOFF.md
  API.md                    ← reference docs (kept at root for links)
  PLUGINS.md
  ...
```
