Cool_Tools/upscayl
1
0
Fork 0
mirror of https://github.com/upscayl/upscayl.git synced 2024-11-27 17:00:52 +01:00
Code Releases Wiki Activity

point towards docs

Browse Source
This commit is contained in:
Aaron Liu 2024-09-07 14:39:36 -04:00
parent 4e786d2d23
commit 0877b880de
No known key found for this signature in database
GPG Key ID: 2D4DA57B12065A35
1 changed files with 3 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/README.md
View File

@ -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.