[PR #130] [MERGED] Refactor the documentation #178

New issue

Closed

opened 2026-10-15 12:49:44 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-15 12:49:44 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/games-on-whales/gow/pull/130
Author: @zb140
Created: 2/5/2023
Status: ✅ Merged
Merged: 2/5/2023
Merged by: @ABeltramo

Base: master ← Head: zb/docs-refactor

📝 Commits (2)

7f1bf75 Refactor the documentation
3cf9b08 add run-gow to the nav menu

📊 Changes

25 files changed (+874 additions, -556 deletions)

View changed files

📝 docs/modules/ROOT/nav.adoc (+16 -13)
➕ docs/modules/ROOT/pages/adding-an-app.adoc (+69 -0)
📝 docs/modules/ROOT/pages/components-overview.adoc (+52 -30)
➕ docs/modules/ROOT/pages/configuration.adoc (+62 -0)
➕ docs/modules/ROOT/pages/connecting.adoc (+21 -0)
➖ docs/modules/ROOT/pages/debian-desktop.adoc (+0 -58)
➖ docs/modules/ROOT/pages/debian-headless.adoc (+0 -62)
➖ docs/modules/ROOT/pages/desktop.adoc (+0 -19)
📝 docs/modules/ROOT/pages/docker-build.adoc (+5 -5)
➖ docs/modules/ROOT/pages/headless-unraid.adoc (+0 -89)
➖ docs/modules/ROOT/pages/headless.adoc (+0 -18)
📝 docs/modules/ROOT/pages/how-to-use.adoc (+35 -44)
➕ docs/modules/ROOT/pages/installation.adoc (+18 -0)
📝 docs/modules/ROOT/pages/nvidia.adoc (+24 -26)
📝 docs/modules/ROOT/pages/overview.adoc (+64 -28)
➕ docs/modules/ROOT/pages/primary-gpu.adoc (+59 -0)
➖ docs/modules/ROOT/pages/raspberry-headless.adoc (+0 -5)
➕ docs/modules/ROOT/pages/requirements.adoc (+85 -0)
📝 docs/modules/ROOT/pages/roadmap.adoc (+11 -13)
➕ docs/modules/ROOT/pages/run-gow.adoc (+132 -0)

...and 5 more files

📄 Description

Ok, so I did a pretty hefty re-write of the documentation. I swear, I just set out to add a page or two then this happened 😁

Mostly what I've done is consolidate the various headless vs host desktop pages to reduce the number of different places where we were saying the exact same thing. One of the tools I used to do this was asciidoctor's tabs plugin (see: https://github.com/games-on-whales/games-on-whales.github.io/pull/2)

However, while I was doing that, I also reformatted some things and edited for grammar/spelling. I also added new pages that cover how to add a new app, how to set a primary GPU if you have multiple, and a deep-dive on how to use run-gow.

_{🔄 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/games-on-whales/gow/pull/130 **Author:** [@zb140](https://github.com/zb140) **Created:** 2/5/2023 **Status:** ✅ Merged **Merged:** 2/5/2023 **Merged by:** [@ABeltramo](https://github.com/ABeltramo) **Base:** `master` ← **Head:** `zb/docs-refactor` --- ### 📝 Commits (2) - [`7f1bf75`](https://github.com/games-on-whales/gow/commit/7f1bf7512beb8a1ec218517a9d0b1bf88007c827) Refactor the documentation - [`3cf9b08`](https://github.com/games-on-whales/gow/commit/3cf9b088cc9d51eb817d0ef8823a0da16577db2b) add run-gow to the nav menu ### 📊 Changes **25 files changed** (+874 additions, -556 deletions) <details> <summary>View changed files</summary> 📝 `docs/modules/ROOT/nav.adoc` (+16 -13) ➕ `docs/modules/ROOT/pages/adding-an-app.adoc` (+69 -0) 📝 `docs/modules/ROOT/pages/components-overview.adoc` (+52 -30) ➕ `docs/modules/ROOT/pages/configuration.adoc` (+62 -0) ➕ `docs/modules/ROOT/pages/connecting.adoc` (+21 -0) ➖ `docs/modules/ROOT/pages/debian-desktop.adoc` (+0 -58) ➖ `docs/modules/ROOT/pages/debian-headless.adoc` (+0 -62) ➖ `docs/modules/ROOT/pages/desktop.adoc` (+0 -19) 📝 `docs/modules/ROOT/pages/docker-build.adoc` (+5 -5) ➖ `docs/modules/ROOT/pages/headless-unraid.adoc` (+0 -89) ➖ `docs/modules/ROOT/pages/headless.adoc` (+0 -18) 📝 `docs/modules/ROOT/pages/how-to-use.adoc` (+35 -44) ➕ `docs/modules/ROOT/pages/installation.adoc` (+18 -0) 📝 `docs/modules/ROOT/pages/nvidia.adoc` (+24 -26) 📝 `docs/modules/ROOT/pages/overview.adoc` (+64 -28) ➕ `docs/modules/ROOT/pages/primary-gpu.adoc` (+59 -0) ➖ `docs/modules/ROOT/pages/raspberry-headless.adoc` (+0 -5) ➕ `docs/modules/ROOT/pages/requirements.adoc` (+85 -0) 📝 `docs/modules/ROOT/pages/roadmap.adoc` (+11 -13) ➕ `docs/modules/ROOT/pages/run-gow.adoc` (+132 -0) _...and 5 more files_ </details> ### 📄 Description Ok, so I did a pretty hefty re-write of the documentation. I swear, I just set out to add a page or two then this happened :grin: Mostly what I've done is consolidate the various headless vs host desktop pages to reduce the number of different places where we were saying the exact same thing. One of the tools I used to do this was asciidoctor's tabs plugin (see: https://github.com/games-on-whales/games-on-whales.github.io/pull/2) However, while I was doing that, I also reformatted some things and edited for grammar/spelling. I also added new pages that cover how to add a new app, how to set a primary GPU if you have multiple, and a deep-dive on how to use `run-gow`. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-15 12:49:44 +00:00