mirror of
https://github.com/upscayl/upscayl.git
synced 2024-12-18 02:16:01 +01:00
Update docs
This commit is contained in:
Nayam Amarshe
parent
8402e3dccc
commit
e8a4b1688c
@ -1,40 +0,0 @@
|
|||||||
If you run into problems with Upscayl, here are a few ways to fix it.
|
|
||||||
|
|
||||||
> [!IMPORTANT]
|
|
||||||
> You'll need a Vulkan compatible GPU to upscale images. Many CPU and iGPUs do not work but no harm in trying.
|
|
||||||
> Make sure to read [the FAQ](https://github.com/upscayl/upscayl#-faq) first to avoid getting rickrolled.
|
|
||||||
|
|
||||||
## General Fixes
|
|
||||||
- Uninstall and Reinstall the app.
|
|
||||||
- Restart your computer.
|
|
||||||
- Try setting your [GPU ID](https://github.com/upscayl/upscayl/wiki/Guide#gpu-id) to your discrete GPU.
|
|
||||||
|
|
||||||
## Linux Users
|
|
||||||
- Reinstall graphics drivers BUT Before doing that, run [VulkanCapsViewer](https://github.com/SaschaWillems/VulkanCapsViewer). If it reports Vulkan support, you might not need to do this.
|
|
||||||
|
|
||||||
## Mac Users
|
|
||||||
- Make sure you're using the latest MacOS update.
|
|
||||||
### If the app doesn't work, try deleting all its files and folders:
|
|
||||||
|
|
||||||
<img src="https://github.com/upscayl/upscayl/assets/25067102/22dab1e0-001f-4212-bb77-904fe36c9916" width="500px" />
|
|
||||||
|
|
||||||
1. Open Finder → Click **Go** in the menu bar → Select **Go to Folder** from the drop-down menu → In the window that appears, type **~/Library/** and press Enter.
|
|
||||||
|
|
||||||
2. Here, in the Library folder, find and remove all files which contain 'Upscayl'.
|
|
||||||
Here's a list of files and folders you can safely delete:
|
|
||||||
**NOTE: PLEASE DO NOT DELETE THE FOLDERS THAT DO NOT HAVE UPSCAYL IN THEIR NAME**
|
|
||||||
- **~/Library/Application Support/Upscayl**
|
|
||||||
- **~/Library/Saved Application State/org.upscayl.Upscayl.savedState/**
|
|
||||||
- **~/Library/Group Containers/W2T4W74X87.org.upscayl.Upscayl**
|
|
||||||
- **~/Library/Containers/Upscayl** (and other folders named Upscayl)
|
|
||||||
- **~/Library/Preferences/org.upscayl.Upscayl.plist/**
|
|
||||||
- **~/Library/Preferences/org.upscayl.Upscayl.helper.plist/**
|
|
||||||
|
|
||||||
## Windows Users
|
|
||||||
- [Set the app to performance mode](https://youtube.com/watch?v=sxvs6qYHJmc) and make sure you have the right redistributables.
|
|
||||||
- Try [DirectX repair](http://blog.csdn.net/vbcom/article/details/6962388).
|
|
||||||
- [Disable switchable graphics](https://nvidia.custhelp.com/app/answers/detail/a_id/5182/~/unable-to-launch-vulkan-apps%2Fgame-on-notebooks-with-amd-radeon-igpus) if you can. (thanks @[JZeravik](https://github.com/JZeravik)!)
|
|
||||||
- [Enable hardware-accelerated GPU scheduling](https://www.howtogeek.com/756935/how-to-enable-hardware-accelerated-gpu-scheduling-in-windows-11) if you can.
|
|
||||||
- Reinstall graphics drivers BUT Before doing that, run [VulkanCapsViewer](https://github.com/SaschaWillems/VulkanCapsViewer). If it reports Vulkan support, you might not need to do this.
|
|
||||||
|
|
||||||
# If all of the above fail, [Please click here to know how you can ask for help](https://github.com/upscayl/upscayl/wiki/%F0%9F%99%8B-How-to-ask-for-help%3F).
|
|
||||||
@ -49,7 +49,18 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Troubleshooting",
|
"group": "Troubleshooting",
|
||||||
"pages": ["logs"]
|
"pages": [
|
||||||
|
{
|
||||||
|
"group": "Introduction",
|
||||||
|
"pages": [
|
||||||
|
"troubleshooting/general-fixes",
|
||||||
|
"troubleshooting/linux",
|
||||||
|
"troubleshooting/mac",
|
||||||
|
"troubleshooting/windows"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"troubleshooting/logs"
|
||||||
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "API Reference",
|
"group": "API Reference",
|
||||||
|
|||||||
@ -1,86 +0,0 @@
|
|||||||
---
|
|
||||||
title: 'Quickstart'
|
|
||||||
description: 'Start building awesome documentation in under 5 minutes'
|
|
||||||
---
|
|
||||||
|
|
||||||
## Setup your development
|
|
||||||
|
|
||||||
Learn how to update your docs locally and deploy them to the public.
|
|
||||||
|
|
||||||
### Edit and preview
|
|
||||||
|
|
||||||
<AccordionGroup>
|
|
||||||
<Accordion icon="github" title="Clone your docs locally">
|
|
||||||
During the onboarding process, we created a repository on your Github with
|
|
||||||
your docs content. You can find this repository on our
|
|
||||||
[dashboard](https://dashboard.mintlify.com). To clone the repository
|
|
||||||
locally, follow these
|
|
||||||
[instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
|
|
||||||
in your terminal.
|
|
||||||
</Accordion>
|
|
||||||
<Accordion icon="rectangle-terminal" title="Preview changes">
|
|
||||||
Previewing helps you make sure your changes look as intended. We built a
|
|
||||||
command line interface to render these changes locally. 1. Install the
|
|
||||||
[Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the
|
|
||||||
documentation changes locally with this command: ``` npm i -g mintlify ```
|
|
||||||
2. Run the following command at the root of your documentation (where
|
|
||||||
`mint.json` is): ``` mintlify dev ```
|
|
||||||
</Accordion>
|
|
||||||
</AccordionGroup>
|
|
||||||
|
|
||||||
### Deploy your changes
|
|
||||||
|
|
||||||
<AccordionGroup>
|
|
||||||
|
|
||||||
<Accordion icon="message-bot" title="Install our Github app">
|
|
||||||
Our Github app automatically deploys your changes to your docs site, so you
|
|
||||||
don't need to manage deployments yourself. You can find the link to install on
|
|
||||||
your [dashboard](https://dashboard.mintlify.com). Once the bot has been
|
|
||||||
successfully installed, there should be a check mark next to the commit hash
|
|
||||||
of the repo.
|
|
||||||
</Accordion>
|
|
||||||
<Accordion icon="rocket" title="Push your changes">
|
|
||||||
[Commit and push your changes to
|
|
||||||
Git](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push)
|
|
||||||
for your changes to update in your docs site. If you push and don't see that
|
|
||||||
the Github app successfully deployed your changes, you can also manually
|
|
||||||
update your docs through our [dashboard](https://dashboard.mintlify.com).
|
|
||||||
</Accordion>
|
|
||||||
|
|
||||||
</AccordionGroup>
|
|
||||||
|
|
||||||
## Update your docs
|
|
||||||
|
|
||||||
Add content directly in your files with MDX syntax and React components. You can use any of our components, or even build your own.
|
|
||||||
|
|
||||||
<CardGroup>
|
|
||||||
|
|
||||||
<Card title="Style Your Docs" icon="paintbrush" href="/settings/global">
|
|
||||||
Add flair to your docs with personalized branding.
|
|
||||||
</Card>
|
|
||||||
|
|
||||||
<Card
|
|
||||||
title="Add API Endpoints"
|
|
||||||
icon="square-code"
|
|
||||||
href="/api-playground/configuration"
|
|
||||||
>
|
|
||||||
Implement your OpenAPI spec and enable API user interaction.
|
|
||||||
</Card>
|
|
||||||
|
|
||||||
<Card
|
|
||||||
title="Integrate Analytics"
|
|
||||||
icon="chart-mixed"
|
|
||||||
href="/analytics/supported-integrations"
|
|
||||||
>
|
|
||||||
Draw insights from user interactions with your documentation.
|
|
||||||
</Card>
|
|
||||||
|
|
||||||
<Card
|
|
||||||
title="Host on a Custom Domain"
|
|
||||||
icon="browser"
|
|
||||||
href="/settings/custom-domain/subdomain"
|
|
||||||
>
|
|
||||||
Keep your docs on your own website's subdomain.
|
|
||||||
</Card>
|
|
||||||
|
|
||||||
</CardGroup>
|
|
||||||
17
docs/troubleshooting/general-fixes.mdx
Normal file
17
docs/troubleshooting/general-fixes.mdx
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
---
|
||||||
|
title: General Fixes
|
||||||
|
description: "Troubleshooting common issues with Upscayl"
|
||||||
|
---
|
||||||
|
|
||||||
|
If you run into problems with Upscayl, here are a few ways to fix it.
|
||||||
|
|
||||||
|
<Note>
|
||||||
|
You'll need a Vulkan compatible GPU to upscale images. Many CPU and iGPUs do not work but no harm in trying. Make sure to read [the FAQ](https://github.com/upscayl/upscayl#-faq) first to avoid getting rickrolled 😁
|
||||||
|
</Note>
|
||||||
|
|
||||||
|
- Uninstall and Reinstall the app.
|
||||||
|
- Restart your computer.
|
||||||
|
- Try setting your [GPU ID](https://github.com/upscayl/upscayl/wiki/Guide#gpu-id) to your discrete GPU.
|
||||||
|
|
||||||
|
<Warning>If all of the above fail, [Please click here to know how you can ask for help](https://github.com/upscayl/upscayl/wiki/%F0%9F%99%8B-How-to-ask-for-help%3F).</Warning>
|
||||||
|
|
||||||
6
docs/troubleshooting/linux.mdx
Normal file
6
docs/troubleshooting/linux.mdx
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
title: Linux Troubleshooting
|
||||||
|
description: "Troubleshooting common issues with Upscayl on Linux"
|
||||||
|
---
|
||||||
|
1. Run [VulkanCapsViewer](https://github.com/SaschaWillems/VulkanCapsViewer). See if your GPU supports Vulkan.
|
||||||
|
2. Reinstall graphics drivers.
|
||||||
BIN
docs/troubleshooting/mac-1.png
Normal file
BIN
docs/troubleshooting/mac-1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 118 KiB |
24
docs/troubleshooting/mac.mdx
Normal file
24
docs/troubleshooting/mac.mdx
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
title: MacOS Troubleshooting
|
||||||
|
description: "Troubleshooting common issues with Upscayl on MacOS"
|
||||||
|
---
|
||||||
|
|
||||||
|
<Warning>
|
||||||
|
If you have MacOS Monterey, you may face issues with the app (empty black screen). This is because Monterey had issues with electron apps, this isn't something we can fix as this is an OS level bug. We recommend upgrading to the latest version of MacOS that your device supports.
|
||||||
|
</Warning>
|
||||||
|
|
||||||
|
1. Make sure you're using the latest MacOS update.
|
||||||
|
|
||||||
|
2. If the app doesn't work, try deleting all its files and folders:
|
||||||
|
1. Open Finder → Click **Go** in the menu bar → Select **Go to Folder** from the drop-down menu → In the window that appears, type **~/Library/** and press Enter. 
|
||||||
|
2. Here, in the `Library` folder, find and remove all files which contain `upscayl`.
|
||||||
|
3. Here's a list of files and folders you can safely delete:
|
||||||
|
<Note>
|
||||||
|
Please do not delete the folders that do not have `upscayl` in their name
|
||||||
|
</Note>
|
||||||
|
- ``~/Library/Application Support/Upscayl``
|
||||||
|
- ``~/Library/Saved Application State/org.upscayl.Upscayl.savedState/``
|
||||||
|
- ``~/Library/Group Containers/W2T4W74X87.org.upscayl.Upscayl``
|
||||||
|
- ``~/Library/Containers/Upscayl`` and other folders there that have `upscayl` in their name.
|
||||||
|
- ``~/Library/Preferences/org.upscayl.Upscayl.plist/``
|
||||||
|
- ``~/Library/Preferences/org.upscayl.Upscayl.helper.plist/``
|
||||||
13
docs/troubleshooting/windows.mdx
Normal file
13
docs/troubleshooting/windows.mdx
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
---
|
||||||
|
title: Windows Troubleshooting
|
||||||
|
description: "Troubleshooting common issues with Upscayl on Windows"
|
||||||
|
---
|
||||||
|
- [Set the app to performance mode](https://youtube.com/watch?v=sxvs6qYHJmc) and make sure you have the right redistributables.
|
||||||
|
- Try [DirectX repair](http://blog.csdn.net/vbcom/article/details/6962388).
|
||||||
|
- [Disable switchable graphics](https://nvidia.custhelp.com/app/answers/detail/a_id/5182/~/unable-to-launch-vulkan-apps%2Fgame-on-notebooks-with-amd-radeon-igpus) if you can.
|
||||||
|
- [Enable hardware-accelerated GPU scheduling](https://www.howtogeek.com/756935/how-to-enable-hardware-accelerated-gpu-scheduling-in-windows-11) if you can.
|
||||||
|
- Run [VulkanCapsViewer](https://github.com/SaschaWillems/VulkanCapsViewer). See if your GPU supports Vulkan.
|
||||||
|
- Reinstall graphics drivers.
|
||||||
|
|
||||||
|
#### Credits
|
||||||
|
Thanks to @[JZeravik](https://github.com/JZeravik) for the switchable graphics tip.
|
||||||
Loading…
Reference in New Issue
Block a user