Skip to content
solvapayPublic

About

No description, website, or topics provided.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

226 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SolvaPay docs (Mintlify)

This repository hosts the Mintlify documentation site for SolvaPay.

Ownership model

  • 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.

AI-assisted writing

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.

Development

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.

Syncing SDK docs

sdks/typescript/**, sdks/python/** and sdks/go/** are owned by the solvapay-sdk repo, next to the code they describe: docs/ (TypeScript), python/docs/ and go/docs/. Don't edit them here. The pages copied are the ones docs.json lists under each sdks/<language>/.

Run the sync from the docs root, with the SDK repo checked out next to this one (or set SDK_REPO_DIR to its root):

npx --yes tsx scripts/sync-sdk-docs.ts --dry-run
npx --yes tsx scripts/sync-sdk-docs.ts
npx --yes tsx scripts/sync-sdk-docs.ts --lang python   # one language

After syncing, run docs checks:

mint validate
mint broken-links

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

Syncing backend OpenAPI docs

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.

Publishing changes

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.

Need help?

Troubleshooting

  • 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.

Resources

About

No description, website, or topics provided.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

Generated from mintlify/starter