Skip to content

Madhouse-Wallet/docs

Repository files navigation

MW Payouts API documentation

The public documentation site for the MW Payouts API (Madhouse Wallet), built on Mintlify.

Structure

  • docs.json — site configuration: branding, navigation (Guides + API Reference tabs), and the OpenAPI source.
  • index.mdx, authentication.mdx, quickstart.mdx — getting-started guides.
  • concepts/ — core concept guides (transfer lifecycle, v1 vs v2, recipients, quotes & fees, compliance, supported currencies).
  • rate-limits-and-errors.mdx, changelog.mdx — reference material.
  • api-reference/introduction.mdx — API reference landing page. The endpoint pages are auto-generated from openapi.json.
  • openapi.json — the OpenAPI 3.0.3 spec. Generated — do not edit by hand (see below).
  • scripts/gen-openapi.mjs — regenerates openapi.json from the API source.

Regenerating the API reference

The spec is the source of truth for every endpoint page. It is generated from the stripe-direct-debit repo's TypeScript spec (src/lib/openapi-spec.ts):

node scripts/gen-openapi.mjs

The script normalizes the spec for Mintlify (resolves nullable types, drops undefined security overrides) and applies concise operation summaries used as the sidebar labels and page slugs. After regenerating, run the checks below.

Development

npm i -g mint   # install the CLI
mint dev        # preview at http://localhost:3000
mint validate   # verify the build
mint broken-links

Publishing

Install the Mintlify GitHub app from your dashboard to deploy automatically on push to the default branch.

Automated drift detection

.github/workflows/openapi-drift.yml checks openapi.json against the live API on a weekday schedule. If the spec has changed upstream, it opens an openapi-drift issue and fails the run — re-sync with npm run sync:live and open a PR.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Generated from mintlify/starter