From 15c031fec627ab8d8652382fe3d8efe657aa767d Mon Sep 17 00:00:00 2001 From: Anthony Sistilli Date: Tue, 28 Oct 2025 14:53:56 -0400 Subject: [PATCH] The spelling of 'deprecated' has been corrected in the project title within the README.md file. This update ensures that the documentation maintains a professional standard and accuracy in terminology. --- apps/docs/README.md | 41 ++++++++++++++++++++++++++++++----------- 1 file changed, 30 insertions(+), 11 deletions(-) diff --git a/apps/docs/README.md b/apps/docs/README.md index 4cbe075..b623688 100644 --- a/apps/docs/README.md +++ b/apps/docs/README.md @@ -1,6 +1,11 @@ +--- +title: Mintlify Starter Kit +description: A comprehensive guide to getting started with the Mintlify Starter Kit, including development, publishing, and troubleshooting tips. +--- + # Mintlify Starter Kit -Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including +Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including: - Guide pages - Navigation @@ -8,25 +13,39 @@ Click on `Use this template` to copy the Mintlify starter kit. The starter kit c - API Reference pages - Use of popular components -### Development +## Development -Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command +Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command: -``` +```bash npm i -g mintlify ``` -Run the following command at the root of your documentation (where mint.json is) +Run the following command at the root of your documentation (where mint.json is): -``` +```bash mintlify dev ``` -### Publishing Changes +## Publishing Changes + +Install our GitHub App to auto-propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard. -Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard. +## Troubleshooting + +- If `mintlify dev` isn't running, run `mintlify install` to re-install dependencies. +- If a page loads as a 404, make sure you are running in a folder with `mint.json`. + +Suggested Structure: + +```json +{ + "title": "", + "sections": [], + "examples": [] +} +``` -#### Troubleshooting +Related Documentation: -- 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` +No related documentation \ No newline at end of file