docs maintenance guide for screenpipe contributors

​

release docs checklist

​

validation

node docs/mintlify/validate-docs.mjs

• 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

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

docs/mintlify/docs-mintlify-mig-tmp/public/app-screenshots/

<img src="https://docs.screenpi.pe/public/app-screenshots/home-home.png" alt="screenpipe home" width="1200" />

​

ownership map

​

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.