From 0877b880de02e39995b0ece6d3ab6a90f883f18a Mon Sep 17 00:00:00 2001 From: Aaron Liu Date: Sat, 7 Sep 2024 14:39:36 -0400 Subject: [PATCH] point towards docs --- docs/README.md | 34 +++------------------------------- 1 file changed, 3 insertions(+), 31 deletions(-) diff --git a/docs/README.md b/docs/README.md index c89c478..9d88a15 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,32 +1,4 @@ -# Mintlify Starter Kit +# Introduction +Welcome to Upscayl Documentation! 🎉 -Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including - -- Guide pages -- Navigation -- Customizations -- API Reference pages -- Use of popular components - -### 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 -``` - -### Publishing Changes - -Install our Github App to autopropagate changes from youre 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` +Here, we’re trying to build documentation around Upscayl for everyone. The .md files under this directory are not regularly updated, and you should use https://github.com/upscayl/upscayl/wiki (or https://docs.upscayl.org) instead.