Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.screenpi.pe/llms.txt

Use this file to discover all available pages before exploring further.

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 typedocs update
new setting or UI flowrelevant guide plus screenshot if it changes the user path
new API route or parameterOpenAPI plus API recipes if user-facing
new connectionconnections and connection reference
new pipe behaviorpipes, pipe debugging, or pipe permissions
meeting featuremeeting intelligence
privacy/security behaviorprivacy data flow and privacy filter
platform reliability fixtroubleshooting
enterprise controlteams or deployment docs

​
validation

run: 
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: 
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: 
docs/mintlify/docs-mintlify-mig-tmp/public/app-screenshots/
then reference them as: 
<img src="https://docs.screenpi.pe/public/app-screenshots/home-home.png" alt="screenpipe home" width="1200" />

​
ownership map

areaowner checklist
get startedfirst value, permissions, desktop vs CLI
MCPclient setup, auth, restart requirements, troubleshooting
APIgenerated OpenAPI, tested recipes, auth examples
pipeslifecycle, permissions, logs, store, publishing
connectionsregistry drift, OAuth, proxy paths, multi-account
meetingstranscript, speakers, summaries, calendar context
privacylocal/cloud data flow, PII, deletion, LAN access
enterpriseteams, managed presets, deployment, encryption
troubleshootingsymptom-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.