mirror of
https://github.com/upscayl/upscayl.git
synced 2024-11-23 23:21:05 +01:00
Update docs
This commit is contained in:
parent
66445ffec5
commit
8402e3dccc
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Introduction
|
||||
description: 'Welcome to Upscayl Documentation! 🎉'
|
||||
description: "Welcome to Upscayl Documentation! 🎉"
|
||||
---
|
||||
|
||||
Here we're trying to build documentation around Upscayl for everyone.
|
||||
@ -10,47 +10,46 @@ This guide will continue to grow as we add more content. If you have any suggest
|
||||
### Contents
|
||||
|
||||
<CardGroup cols={2}>
|
||||
<Card
|
||||
<Card
|
||||
title="🙋 How to ask for help?"
|
||||
href="https://github.com/upscayl/upscayl/wiki/%F0%9F%99%8B-How-to-ask-for-help%3F"
|
||||
>
|
||||
Read this guide to learn how to ask for help on Upscayl's GitHub.
|
||||
</Card>
|
||||
<Card
|
||||
<Card
|
||||
title="🧩 Compatibility List"
|
||||
href="https://github.com/upscayl/upscayl/wiki/Compatibility-List"
|
||||
>
|
||||
Check if your GPU is compatible with Upscayl.
|
||||
</Card>
|
||||
<Card
|
||||
<Card
|
||||
title="📖 User Guide"
|
||||
href="https://github.com/upscayl/upscayl/wiki/Guide"
|
||||
>
|
||||
Learn the various confusing features of Upscayl.
|
||||
</Card>
|
||||
<Card
|
||||
<Card
|
||||
title="🔨 Troubleshooting"
|
||||
href="https://github.com/upscayl/upscayl/wiki/Troubleshooting"
|
||||
>
|
||||
Learn how to troubleshoot common issues with Upscayl.
|
||||
</Card>
|
||||
<Card
|
||||
<Card
|
||||
title="🖥️ Model Conversion Guide"
|
||||
href="https://github.com/upscayl/upscayl/wiki/Model-Conversion-Guide"
|
||||
>
|
||||
Learn how to convert PyTorch models to NCNN models for Upscayl.
|
||||
</Card>
|
||||
<Card
|
||||
<Card
|
||||
title="🤫 Miscellaneous Configuration"
|
||||
href="https://github.com/upscayl/upscayl/wiki/Misc"
|
||||
>
|
||||
Learn about the miscellaneous configurations in Upscayl.
|
||||
</Card>
|
||||
<Card
|
||||
<Card
|
||||
title="🤯 Using Upscayl on Windows and Linux with only a CPU"
|
||||
href="https://github.com/upscayl/upscayl/issues/390"
|
||||
>
|
||||
Learn how to use Upscayl on Windows and Linux without a graphics card.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
|
14
docs/logs.mdx
Normal file
14
docs/logs.mdx
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Logs
|
||||
description: "How to view and share logs in Upscayl"
|
||||
---
|
||||
|
||||
## Steps
|
||||
To view logs in Upscayl, you can use the following methods:
|
||||
|
||||
1. Open the Upscayl app.
|
||||
2. Click on the `Settings` tab.
|
||||
3. Under the `LOGS` section, you can view the logs in real-time.
|
||||
4. To share the logs, click on the `COPY LOGS 📋` button to copy the logs to your clipboard.
|
||||
5. To share the logs with the Upscayl team, go to [LogPasta](https://logpasta.com/) and paste the logs there.
|
||||
6. Share the LogPasta link with the Upscayl team.
|
@ -46,9 +46,20 @@
|
||||
{
|
||||
"group": "Get Started",
|
||||
"pages": ["introduction"]
|
||||
},{
|
||||
},
|
||||
{
|
||||
"group": "Troubleshooting",
|
||||
"pages": ["logs"]
|
||||
},
|
||||
{
|
||||
"group": "API Reference",
|
||||
"pages": ["get-task-status", "get-upload-url", "complete-a-multipart-upload", "get-upscayl-history", "start-a-new-task"]
|
||||
"pages": [
|
||||
"get-task-status",
|
||||
"get-upload-url",
|
||||
"complete-a-multipart-upload",
|
||||
"get-upscayl-history",
|
||||
"start-a-new-task"
|
||||
]
|
||||
}
|
||||
],
|
||||
"footerSocials": {
|
||||
|
Loading…
Reference in New Issue
Block a user