mirror of
https://github.com/upscayl/upscayl.git
synced 2024-11-23 23:21:05 +01:00
Update docs
This commit is contained in:
Nayam Amarshe
parent
e8a4b1688c
commit
4f93f24762
14
docs/Home.md
14
docs/Home.md
@ -1,14 +0,0 @@
|
||||
# Welcome to the Upscayl wiki!
|
||||
|
||||
Here we're trying to build documentation around Upscayl for everyone. If you have any suggestions, please feel free to let us know! :)
|
||||
|
||||
## Contents
|
||||
- [🙋 How to ask for help?](https://github.com/upscayl/upscayl/wiki/%F0%9F%99%8B-How-to-ask-for-help%3F)
|
||||
- [🧩 Compatibility List](https://github.com/upscayl/upscayl/wiki/Compatibility-List)
|
||||
- [📖 User Guide](https://github.com/upscayl/upscayl/wiki/Guide)
|
||||
- [🔨 Troubleshooting](https://github.com/upscayl/upscayl/wiki/Troubleshooting)
|
||||
- [🖥️ Model Conversion Guide](https://github.com/upscayl/upscayl/wiki/Model-Conversion-Guide)
|
||||
- [🤫 Miscellaneous Configuration](https://github.com/upscayl/upscayl/wiki/Misc)
|
||||
- [🤯 Using Upscayl on Windows and Linux with only a CPU](https://github.com/upscayl/upscayl/issues/390)
|
||||
|
||||
|
||||
@ -1,22 +0,0 @@
|
||||
# How to Ask for Help on Upscayl's GitHub
|
||||
|
||||
> [!NOTE]
|
||||
**If you're having issues with the Mac App Store version of Upscayl, please email [Nayam Amarshe](mailto:nayam.emikx@aleeas.com).**
|
||||
|
||||
> [!WARNING]
|
||||
**Please do not Email or Telegram us for any bugs or issues that you encounter. You will not receive any replies. We only use GitHub issues for issue tracking.**
|
||||
|
||||
GitHub is a powerful platform that fosters collaboration and open-source development. If you're new to GitHub and need assistance with Upscayl, follow these steps to effectively ask for help:
|
||||
|
||||
### 1. Search for Similar Issues
|
||||
Before posting a new issue, [search the repository's issue tracker](https://github.com/upscayl/upscayl/issues) to check if someone else has encountered a similar problem. Also [check the discussions tab](https://github.com/upscayl/upscayl/discussions) for any pre-existing discussions. This helps to avoid duplicate issues and ensures that you're not asking a question that has already been answered. You should also check the [FAQ](https://github.com/upscayl/upscayl/tree/main#-faq).
|
||||
|
||||
### 2. Provide Logs and Context
|
||||
- To create a new issue, go to the [Issues tab](https://github.com/upscayl/upscayl/issues) and click **'New Issue'**.
|
||||
|
||||
Make sure to provide detailed context about the problem you're facing. Include relevant information such as the logs, version of the software, the steps to reproduce the issue, and any error messages you've encountered. This will help others understand your problem better and provide more accurate assistance.
|
||||
|
||||
If you don't know how to copy/see the logs, [follow this link](https://github.com/upscayl/upscayl/wiki/Guide#logs).
|
||||
|
||||
### 3. Be Clear and Specific
|
||||
Clearly articulate your issue or question in a concise manner. The title should clearly mention the problem. Avoid ambiguous language and provide specific details about what you're trying to achieve. This will make it easier for others to understand your problem and offer a targeted solution. Our default issue template provides a suggested, organized way to do this.
|
||||
@ -1,98 +0,0 @@
|
||||
---
|
||||
title: 'Development'
|
||||
description: 'Learn how to preview changes locally'
|
||||
---
|
||||
|
||||
<Info>
|
||||
**Prerequisite** You should have installed Node.js (version 18.10.0 or
|
||||
higher).
|
||||
</Info>
|
||||
|
||||
Step 1. Install Mintlify on your OS:
|
||||
|
||||
<CodeGroup>
|
||||
|
||||
```bash npm
|
||||
npm i -g mintlify
|
||||
```
|
||||
|
||||
```bash yarn
|
||||
yarn global add mintlify
|
||||
```
|
||||
|
||||
</CodeGroup>
|
||||
|
||||
Step 2. Go to the docs are located (where you can find `mint.json`) and run the following command:
|
||||
|
||||
```bash
|
||||
mintlify dev
|
||||
```
|
||||
|
||||
The documentation website is now available at `http://localhost:3000`.
|
||||
|
||||
### Custom Ports
|
||||
|
||||
Mintlify uses port 3000 by default. You can use the `--port` flag to customize the port Mintlify runs on. For example, use this command to run in port 3333:
|
||||
|
||||
```bash
|
||||
mintlify dev --port 3333
|
||||
```
|
||||
|
||||
You will see an error like this if you try to run Mintlify in a port that's already taken:
|
||||
|
||||
```md
|
||||
Error: listen EADDRINUSE: address already in use :::3000
|
||||
```
|
||||
|
||||
## Mintlify Versions
|
||||
|
||||
Each CLI is linked to a specific version of Mintlify. Please update the CLI if your local website looks different than production.
|
||||
|
||||
<CodeGroup>
|
||||
|
||||
```bash npm
|
||||
npm i -g mintlify@latest
|
||||
```
|
||||
|
||||
```bash yarn
|
||||
yarn global upgrade mintlify
|
||||
```
|
||||
|
||||
</CodeGroup>
|
||||
|
||||
## Deployment
|
||||
|
||||
<Tip>
|
||||
Unlimited editors available under the [Startup
|
||||
Plan](https://mintlify.com/pricing)
|
||||
</Tip>
|
||||
|
||||
You should see the following if the deploy successfully went through:
|
||||
|
||||
<Frame>
|
||||
<img src="/images/checks-passed.png" style={{ borderRadius: '0.5rem' }} />
|
||||
</Frame>
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Here's how to solve some common problems when working with the CLI.
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="Mintlify is not loading">
|
||||
Update to Node v18. Run `mintlify install` and try again.
|
||||
</Accordion>
|
||||
<Accordion title="No such file or directory on Windows">
|
||||
Go to the `C:/Users/Username/.mintlify/` directory and remove the `mint`
|
||||
folder. Then Open the Git Bash in this location and run `git clone
|
||||
https://github.com/mintlify/mint.git`.
|
||||
|
||||
Repeat step 3.
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="Getting an unknown error">
|
||||
Try navigating to the root of your device and delete the ~/.mintlify folder.
|
||||
Then run `mintlify dev` again.
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
Curious about what changed in a CLI version? [Check out the CLI changelog.](/changelog/command-line)
|
||||
Loading…
Reference in New Issue
Block a user