Red Fancy Docs

Mintlify-based documentation for the Red Fancy backend API.

Source of Truth

• OPENAPI.yaml contains the current backend API specification.
• docs.json defines navigation, theme, and OpenAPI integration.
• pay/*.mdx contains guide pages that explain integration flows around the raw reference.

The API reference shown in the docs site is generated directly from OPENAPI.yaml.

Local Development

Install the Mintlify CLI:

npm i -g mint

Start the local preview:

mint dev

The preview runs at http://localhost:3000.

Validation

Validate the OpenAPI file:

mint openapi-check OPENAPI.yaml

Check internal links:

mint broken-links

Updating the Docs

1. Update OPENAPI.yaml when the backend contract changes.
2. Refresh the relevant guide pages in pay/ if the integration flow changed.
3. Run the validation commands above before publishing.