Skip to main content
Prerequisites:
  • Bun 1.4.2 (for bun install, bun run dev, and OpenAPI sync scripts)
  • Node.js 19 or higher (Mintlify CLI)
  • The D-Sports docs repo with a docs.json file at the root
This page is for contributing to this documentation site (D-Sports Docs at docs.d-sports.org). To work on the PWA/API, native app, marketing site, Rust backend, or Mic’d Up, see the Repositories section.
1

Install dependencies with Bun 1.4.2

Confirm the toolchain, then install:
2

Install the Mintlify CLI

3

Preview locally

In the docs directory (where docs.json is), run:
Or run mint dev directly if the OpenAPI spec is already up to date. The site is available at http://localhost:3000.

​
Custom ports

Use the --port flag to run on a different port:
If the default port is in use, Mintlify will try the next available port.

​
Keeping the CLI up to date

If the local preview doesn’t match production, update the CLI:
Check for broken internal links:
You can also run mint validate to check that the docs build correctly.

​
Deployment

When you push to the default branch, the docs deploy automatically (if the repo is connected via the Mintlify GitHub app). The live site is docs.d-sports.org.
Screenshot of a deployment confirmation message that says All checks have passed.

​
Code formatting

Use IDE support for MDX: for example, the MDX VSCode extension for syntax highlighting and Prettier for formatting. See AGENTS.md in the repo for D-Sports docs style and the Mintlify skill.

​
Troubleshooting

Often caused by an outdated Node version. Try:
  1. Remove the CLI: npm remove -g mint
  2. Upgrade to Node v19 or higher.
  3. Reinstall: npm i -g mint
Delete the ~/.mintlify folder on your machine, then run mint dev again.
For Mintlify CLI changes, see the CLI changelog.