From 69b9881cbc68ce634393be20098460cf4df2bfb6 Mon Sep 17 00:00:00 2001 From: Emmanuel Oloyede Date: Sun, 22 Oct 2023 16:40:33 +0100 Subject: [PATCH] docs: add README file for instructions on how to get the doc started in local development --- docs/CONTRIBUTING.MD | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 docs/CONTRIBUTING.MD diff --git a/docs/CONTRIBUTING.MD b/docs/CONTRIBUTING.MD new file mode 100644 index 000000000..a74f0985e --- /dev/null +++ b/docs/CONTRIBUTING.MD @@ -0,0 +1,24 @@ +# Contributing to the documentation + +## Getting familiar with Mintlify +New to Mintlify. [Start Here](https://mintlify.com/docs/quickstart) + + +## 👩‍💻 Development + +Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command + +``` +npm i -g mintlify +``` + +Run the following command at the root of your documentation (where mint.json is) + +``` +mintlify dev +``` + +## Troubleshooting + +- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies. +- Page loads as a 404 - Make sure you are running in a folder with `mint.json`. Check the `/docs` folder