Skip to main content

Get started in three steps

Run the D-Sports Documentation site locally, or jump to running one of the apps (PWA, site, native, Mic’d Up).

Step 1: Run the docs locally

Clone the D-Sports docs repository and open it in your editor. The repo contains the content for docs.d-sports.org.
  1. Install the Mintlify CLI: npm i -g mint
  2. In the docs directory (where docs.json lives), run: mint dev
  3. Open http://localhost:3000 to see the docs.
Changes to MDX and docs.json update automatically in the preview.

Step 2: (Optional) Run an app

To run one of the D-Sports applications (PWA, marketing site, native app, or Mic’d Up), use the repo-specific instructions: See the Ecosystem overview and each repo page for prerequisites (Node, Bun, PostgreSQL, env vars).

Step 3: Deploy docs changes

  1. Commit and push your changes to the default branch.
  2. If the D-Sports docs are connected via the Mintlify GitHub app, the site at docs.d-sports.org updates automatically after the push.

Next steps

Ecosystem overview

How the four repositories fit together.

d-sports-api

PWA and backend setup.

Development

Contributing to this docs site: CLI, validation, formatting.

API reference

API documentation for d-sports-api.
Docs platform: These docs are built with Mintlify. For Mintlify-specific help, see mintlify.com/docs.