> ## Documentation Index
> Fetch the complete documentation index at: https://docs.screenpipe.com/llms.txt
> Use this file to discover all available pages before exploring further.

# docs maintenance guide for screenpipe contributors

> How screenpipe maintainers keep docs synced with product changes, OpenAPI routes, app connections, UI screenshots, and changelog release notes.

{/* https://screenpi.pe */}

screenpipe moves quickly. every user-facing change should leave the docs in a better state than it found them.

## release docs checklist

for every release PR or feature PR, check:

| change type                | docs update                                                                                  |
| -------------------------- | -------------------------------------------------------------------------------------------- |
| new setting or UI flow     | relevant guide plus screenshot if it changes the user path                                   |
| new API route or parameter | OpenAPI plus [API recipes](/api-recipes) if user-facing                                      |
| new connection             | [connections](/connections) and [connection reference](/connection-reference)                |
| new pipe behavior          | [pipes](/pipes), [pipe debugging](/pipe-debugging), or [pipe permissions](/pipe-permissions) |
| meeting feature            | [meeting intelligence](/meeting-intelligence)                                                |
| privacy/security behavior  | [privacy data flow](/privacy-data-flow) and [privacy filter](/privacy-filter)                |
| platform reliability fix   | [troubleshooting](/troubleshooting)                                                          |
| enterprise control         | [teams](/teams) or deployment docs                                                           |

## validation

run:

```bash theme={null}
node docs/mintlify/validate-docs.mjs
```

this checks:

* `docs.json` is valid JSON
* every nav page exists
* no MDX page is missing from nav
* each MDX file has frontmatter with `title` and `description`
* internal docs links point to a known page or public asset
* `openapi.yaml` contains routes
* the connection registry can be read from code

## screenshot workflow

screenshots come from app e2e specs:

```bash theme={null}
cd apps/screenpipe-app-tauri
bun run wdio run e2e/wdio.conf.ts \
  --spec e2e/specs/home-window.spec.ts \
  --spec e2e/specs/settings-sections.spec.ts \
  --spec e2e/specs/pipes.spec.ts
```

copy selected images from `apps/screenpipe-app-tauri/e2e/screenshots/` into:

```text theme={null}
docs/mintlify/docs-mintlify-mig-tmp/public/app-screenshots/
```

then reference them as:

```mdx theme={null}
<img src="https://docs.screenpi.pe/public/app-screenshots/home-home.png" alt="screenpipe home" width="1200" />
```

## ownership map

| area            | owner checklist                                           |
| --------------- | --------------------------------------------------------- |
| get started     | first value, permissions, desktop vs CLI                  |
| MCP             | client setup, auth, restart requirements, troubleshooting |
| API             | generated OpenAPI, tested recipes, auth examples          |
| pipes           | lifecycle, permissions, logs, store, publishing           |
| connections     | registry drift, OAuth, proxy paths, multi-account         |
| meetings        | transcript, speakers, summaries, calendar context         |
| privacy         | local/cloud data flow, PII, deletion, LAN access          |
| enterprise      | teams, managed presets, deployment, encryption            |
| troubleshooting | symptom-first fixes by platform                           |

## drift rules

* if a route is added to code, OpenAPI and docs should mention it or intentionally keep it reference-only.
* if a connection is added to `screenpipe-connect`, docs must include it in the reference.
* if release notes mention a feature, the durable guide should also explain how to use it.
* if a screenshot changes materially, update the image in the same PR.