Docs Review

Keep the Mintlify docs and OpenAPI spec aligned with the backend.

The OpenAPI file is the source of truth for generated API reference pages:

docs/developer-api/mintlify/openapi/pocketmusala-developer-api-v1.yaml

Review Checklist

Run this checklist whenever functions/src/developerApi/*, dataconnect/pocketmusala/prayer_times.gql, or the Developer API portal changes.

1. Compare route methods, paths, request bodies, response bodies, auth headers, scopes, and error codes with functions/src/developerApi/mosqueProfileSync.ts.
2. Compare key lifecycle language with functions/src/developerApi/adminPortal.ts and functions/src/developerApi/apiKeys.ts.
3. Compare prayer row fields and multi-Jummah behavior with dataconnect/pocketmusala/prayer_times.gql.
4. Update the OpenAPI file first.
5. Update guide pages only after the OpenAPI file matches the backend.
6. Validate OpenAPI and Mintlify navigation.
7. Confirm the Developer API portal has a visible docs link.

Commands

From the repository root:

npx --yes @redocly/cli lint docs/developer-api/mintlify/openapi/pocketmusala-developer-api-v1.yaml
npx --yes mint validate docs/developer-api/mintlify

If the quickstart changes, test it with a controlled PocketMusala test account before publishing. Never commit a raw key, full Authorization header, or unredacted support log.