Development

Contribute to the D-Sports docs site. Preview locally, validate links, and deploy to docs.d-sports.org.

Prerequisites:

• Node.js 19 or higher
• 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, site, native app, or Mic’d Up, see the Repositories section.

1. Install the Mintlify CLI

   npm i -g mint
   
2. Preview locally

   In the docs directory (where docs.json is), run:

   mint dev
   

   The site is available at http://localhost:3000.

Custom ports

Use the --port flag to run on a different port:

mint dev --port 3333

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:

mint update

Validating links

Check for broken internal links:

mint broken-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.

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

Error: Could not load the "sharp" module using the darwin-arm64 runtime

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

Unknown error or odd behavior

Delete the ~/.mintlify folder on your machine, then run mint dev again.

For Mintlify CLI changes, see the CLI changelog.