[PR #513] [MERGED] Expand documentation on configuration and debugging #1606

New issue

Closed

opened 2026-02-27 21:13:15 +03:00 by kerem · 0 comments

kerem commented

2026-02-27 21:13:15 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/shadps4-emu/shadPS4/pull/513
Author: @xezrunner
Created: 8/21/2024
Status: ✅ Merged
Merged: 8/21/2024
Merged by: @georgemoralis

Base: main ← Head: xezrunner/documentation

📝 Commits (10+)

ec5b3e4 documents: more info on config.toml
db402aa documents: add Debugging
1e5af58 documents: link to Debugging in README
aa888ed documents: link to main branch for Debugging
daaeed0 documents: remove "troubleshooting" from Debugging
d03de96 documents: elaborate on a few points with stack traces
b6db769 documents: formatting, indentation fixup
483830c documents: remove unnecessary indent
e858f70 documents: fix some inline code blocks + misc
52a1062 documents: move the technical jargon out of Quickstart

📊 Changes

3 files changed (+176 additions, -1 deletions)

View changed files

📝 README.md (+4 -0)
➕ documents/Debugging/Debugging.md (+151 -0)
📝 documents/Quickstart/Quickstart.md (+21 -1)

📄 Description

I added some extra documentation for:

NOTE: deep links will not work in these previews, as they are on my own fork/branch. I linked these to the original repo's main branch, assuming their final path upon merging.

Let me know if any of the points are inaccurate or need expanding upon for this first iteration.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/shadps4-emu/shadPS4/pull/513 **Author:** [@xezrunner](https://github.com/xezrunner) **Created:** 8/21/2024 **Status:** ✅ Merged **Merged:** 8/21/2024 **Merged by:** [@georgemoralis](https://github.com/georgemoralis) **Base:** `main` ← **Head:** `xezrunner/documentation` --- ### 📝 Commits (10+) - [`ec5b3e4`](https://github.com/shadps4-emu/shadPS4/commit/ec5b3e4706868ceddf1b203b43a940807fd32d53) documents: more info on config.toml - [`db402aa`](https://github.com/shadps4-emu/shadPS4/commit/db402aa2f611decc336b0f214190cc94baf8e9f3) documents: add Debugging - [`1e5af58`](https://github.com/shadps4-emu/shadPS4/commit/1e5af58e636b5a12ce8109fca38a5b1efab35e0b) documents: link to Debugging in README - [`aa888ed`](https://github.com/shadps4-emu/shadPS4/commit/aa888eda78b1206190b3f198cf5fc45e67886407) documents: link to main branch for Debugging - [`daaeed0`](https://github.com/shadps4-emu/shadPS4/commit/daaeed0a3e333d5895aeb37a339959374bdbda53) documents: remove "troubleshooting" from Debugging - [`d03de96`](https://github.com/shadps4-emu/shadPS4/commit/d03de96b85229556558676839fff8bc22169fc62) documents: elaborate on a few points with stack traces - [`b6db769`](https://github.com/shadps4-emu/shadPS4/commit/b6db769a2098574a21c9167e200e8149371b8906) documents: formatting, indentation fixup - [`483830c`](https://github.com/shadps4-emu/shadPS4/commit/483830cd65669ccdf3c210673a9e93d241063076) documents: remove unnecessary indent - [`e858f70`](https://github.com/shadps4-emu/shadPS4/commit/e858f70baaf64a4ceda688e2793d0c892d7c1183) documents: fix some inline code blocks + misc - [`52a1062`](https://github.com/shadps4-emu/shadPS4/commit/52a1062174fb0f2f59fbc6e53db95c83bccf3f18) documents: move the technical jargon out of Quickstart ### 📊 Changes **3 files changed** (+176 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+4 -0) ➕ `documents/Debugging/Debugging.md` (+151 -0) 📝 `documents/Quickstart/Quickstart.md` (+21 -1) </details> ### 📄 Description I added some extra documentation for: - [**Quickstart**: configuration](https://github.com/xezrunner/shadPS4/blob/xezrunner/documentation/documents/Quickstart/Quickstart.md#configure-the-emulator) - [**Debugging**: explainer on basic debugging + issue reporting](https://github.com/xezrunner/shadPS4/blob/xezrunner/documentation/documents/Debugging/Debugging.md) NOTE: deep links will not work in these previews, as they are on my own fork/branch. I linked these to the original repo's `main` branch, assuming their final path upon merging. Let me know if any of the points are inaccurate or need expanding upon for this first iteration. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>