// readme

Turnkey docs

This repo hosts the documentation hosted at https://docs.turnkey.com.

Development

Prerequisites

To work with this documentation locally, you’ll need:

  • Node.js (see .nvmrc for the recommended version)
  • npm or yarn

Local Development

Install the Mintlify CLI to preview documentation changes locally:

# Install Mintlify CLI globally
npm i -g mintlify

# Start the local development server
mintlify dev

This will start a local development server where you can preview your changes in real-time.

If you encounter any issues with the development server:

  • Run mintlify install to reinstall dependencies
  • Ensure you’re running the command in a folder with docs.json (Mintlify’s configuration file)

Important: If you previously worked with the Docusaurus version of this site, make sure to delete the build and .docusaurus folders before running the Mintlify docs site locally. Otherwise, you may experience style conflicts.

Deployment

Changes to the documentation are automatically deployed when merged to the main branch through our CI/CD pipeline.

Mintlify Dashboard

You can access…