From 3b0f2f2003ed2a70c75c04993839b494557add12 Mon Sep 17 00:00:00 2001 From: Justin Spahr-Summers Date: Wed, 20 Nov 2024 15:37:09 +0000 Subject: [PATCH] Update README.md --- README.md | 23 +++-------------------- 1 file changed, 3 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 6c10353..a7d2a6e 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,9 @@ # Model Context Protocol Documentation -The official docs of MCP. This README is a WIP. +The official documentation for the [Model Context Protocol](https://modelcontextprotocol.io). -### 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 -``` +For detailed contribution guidelines, development setup, and troubleshooting, please see our [Contributing Guide](CONTRIBUTING.md). ### 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. - -#### 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` +Changes will be deployed to production automatically after pushing to the default branch.