SolvaPay docs (Mintlify)

This repository hosts the Mintlify documentation site for SolvaPay.

• Product docs (get-started, guides, no-code-mcp, mcp-server, plans, webhooks) are maintained in this repository.
• TypeScript SDK docs (sdks/typescript) are upstream-owned and synced into this repository.
• API reference (api-reference/openapi.json) is generated from backend OpenAPI and synced manually.
• Do not manually edit sdks/typescript/**. Use the sync script.
• Do not manually edit api-reference/openapi.json. Use the sync script.
• meters/** and internal/** are non-nav sections.

Set up your AI coding tool to work with Mintlify:

npx skills add https://mintlify.com/docs

This command installs Mintlify's documentation skill for your configured AI tools.

Install the Mintlify CLI to preview your documentation changes locally. To install, use the following command:

npm i -g mint

Run the following command at the root of your documentation, where your docs.json is located:

mint dev

View your local preview at http://localhost:3000.

The sdks/typescript/** content is upstream-owned and synced from the SDK repository. Do not manually edit files under sdks/typescript/**.

Run sync from the docs root:

npx --yes tsx scripts/sync-typescript-sdk-docs.ts

If your SDK docs source is in a custom location, set:

SDK_DOCS_SOURCE_DIR="/absolute/path/to/solvapay-sdk/docs" npx --yes tsx scripts/sync-typescript-sdk-docs.ts

Helpful flags:

# Preview changes without writing files
npx --yes tsx scripts/sync-typescript-sdk-docs.ts --dry-run

After syncing, run docs checks:

mint validate
mint broken-links

The sync script reads the TypeScript SDK page list directly from docs.json.

Run the sync script from the docs root:

npx --yes tsx scripts/sync-backend-openapi.ts

If you want to test against another backend environment, set:

BACKEND_OPENAPI_URL="https://api.solvapay.com/v1/openapi.json" npx --yes tsx scripts/sync-backend-openapi.ts

The sync uses fail-closed path filtering and only keeps external SDK operations under /v1/sdk/*. Non-SDK operations (for example ui/*, admin, and internal endpoints) are excluded from published API reference output.

You can also run .github/workflows/sync-backend-openapi.yml manually (workflow_dispatch) if you prefer syncing through GitHub Actions.

See API_REFERENCE_OWNERSHIP.md for generated file ownership policy.

Install our GitHub app from your dashboard to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.

• If your dev environment isn't running: Run mint update to ensure you have the most recent version of the CLI.
• If a page loads as a 404: Make sure you are running in a folder with a valid docs.json.

• Mintlify documentation