Skip to content

Latest commit

 

History

History
60 lines (46 loc) · 2.51 KB

File metadata and controls

60 lines (46 loc) · 2.51 KB
title Quickstart
description Run the D-Sports docs locally or one of the four apps in three steps

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](https://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.
<Tip>Changes to MDX and `docs.json` update automatically in the preview.</Tip>

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

How the four repositories fit together. PWA and backend setup. Contributing to this docs site: CLI, validation, formatting. API documentation for d-sports-api. **Docs platform:** These docs are built with [Mintlify](https://mintlify.com). For Mintlify-specific help, see [mintlify.com/docs](https://mintlify.com/docs).