Skip to content

Commit 536bf49

Browse files
Merge pull request #8 from World-Domination-Software/copilot/cleanup-and-connect-documentation
2 parents 656af14 + 36f954d commit 536bf49

37 files changed

Lines changed: 1989 additions & 313 deletions

.github/workflows/wiki-sync.yml

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ on:
66
- main
77
paths:
88
- 'docs/**'
9+
- 'wiki/**'
910
- 'README.md'
1011
- 'SUPPORT.md'
1112
- 'CONTRIBUTING.md'
@@ -40,38 +41,45 @@ jobs:
4041
env:
4142
WIKI_TOKEN: ${{ secrets.WIKI_TOKEN }}
4243
run: |
43-
git clone "https://x-access-token:${WIKI_TOKEN}@github.com/World-Domination-Software/Projects.wiki.git" wiki
44+
git clone "https://x-access-token:${WIKI_TOKEN}@github.com/World-Domination-Software/Projects.wiki.git" wiki-repo
4445
4546
- name: Copy markdown docs into wiki root (flat)
4647
run: |
4748
shopt -s nullglob
4849
# Copy top-level docs/*.md into wiki root
4950
for file in docs/*.md; do
5051
base="$(basename "$file")"
51-
echo "Copying $file -> wiki/$base"
52-
cp "$file" "wiki/$base"
52+
echo "Copying $file -> wiki-repo/$base"
53+
cp "$file" "wiki-repo/$base"
54+
done
55+
56+
# Copy wiki/*.md files into wiki root (these are the primary wiki page sources)
57+
for file in wiki/*.md; do
58+
base="$(basename "$file")"
59+
echo "Copying $file -> wiki-repo/$base"
60+
cp "$file" "wiki-repo/$base"
5361
done
5462
5563
# Copy key root docs into wiki root
5664
for file in README.md SUPPORT.md CONTRIBUTING.md; do
5765
if [ -f "$file" ]; then
58-
echo "Copying $file -> wiki/$file"
59-
cp "$file" "wiki/$file"
66+
echo "Copying $file -> wiki-repo/$file"
67+
cp "$file" "wiki-repo/$file"
6068
fi
6169
done
6270
6371
- name: Sync documentation images (banner and icons)
6472
run: |
6573
if [ -d docs/images ]; then
66-
mkdir -p wiki/images
67-
echo "Syncing docs/images -> wiki/images"
68-
cp -R docs/images/* wiki/images/
74+
mkdir -p wiki-repo/images
75+
echo "Syncing docs/images -> wiki-repo/images"
76+
cp -R docs/images/* wiki-repo/images/
6977
else
7078
echo "No docs/images directory to sync."
7179
fi
7280
7381
- name: Commit and push changes to wiki
74-
working-directory: wiki
82+
working-directory: wiki-repo
7583
run: |
7684
if [ -n "$(git status --porcelain)" ]; then
7785
git add .

wiki/Bug-Reporting.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Bug Reporting
2+
3+
A clear, detailed bug report helps us investigate and fix issues faster.
4+
5+
## Choosing the Right Template
6+
7+
When filing an issue in this repository, select the template that best matches your problem:
8+
9+
| Template | Use for |
10+
|---|---|
11+
| **Bug report** | Gameplay or UI problems |
12+
| **Crash report** | Crashes, hard freezes, or forced restarts |
13+
| **Performance issue** | Low FPS, stuttering, or unusually long load times |
14+
| **Multiplayer / online issue** | Connection, matchmaking, or sync problems |
15+
16+
➡️ [Open an Issue](https://github.com/World-Domination-Software/Projects/issues/new/choose)
17+
18+
## What to Include
19+
20+
The more detail you provide, the faster we can investigate. Try to include:
21+
22+
- **Platform** – Windows, Linux, macOS, Android, iOS, Steam Deck, or other.
23+
- **Game version / build** – Shown on the main menu, launcher, or store page.
24+
- **Steps to reproduce** – Instructions someone else can follow from a fresh start.
25+
- **Expected vs. actual behavior** – What you thought would happen vs. what did happen.
26+
- **Frequency** – Does it happen every time, sometimes, or only once?
27+
- **Logs or error messages** – Short excerpts showing relevant errors (avoid including personal data).
28+
29+
## Example of a Good Bug Report
30+
31+
> **Summary:** Inventory item disappears when dragged onto quickbar.
32+
>
33+
> **Steps to reproduce:**
34+
> 1. Start a new game.
35+
> 2. Pick up any item.
36+
> 3. Drag it onto quickbar slot 1.
37+
>
38+
> **Expected:** The item appears in slot 1 and remains in inventory.
39+
>
40+
> **Actual:** The item disappears from both the inventory and quickbar.
41+
>
42+
> **Frequency:** Every time. **Platform:** Windows 11. **Build:** v1.3.2.
43+
44+
## Before Filing
45+
46+
It helps to check first:
47+
48+
- Search [existing issues](https://github.com/World-Domination-Software/Projects/issues) for similar reports — including closed issues.
49+
- Try the steps in [[Troubleshooting-Index]] to rule out common causes.
50+
- If you are not sure it is a bug, start a [Support Discussion](https://github.com/World-Domination-Software/Projects/discussions) instead.
51+
52+
## After Filing
53+
54+
- A maintainer will label your issue (`triage`, `needs-info`, `confirmed`, etc.).
55+
- We may ask for additional details if we cannot reproduce the problem.
56+
- Once fixed, the issue will be labeled `fixed` and closed when the fix ships.
57+
58+
---
59+
60+
**[[Home]] · [[Troubleshooting-Index]] · [[Support]] · [[FAQ]]**

wiki/Community-and-Discussions.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Community and Discussions
2+
3+
GitHub Discussions is our primary channel for community interaction. This page explains where to ask questions, report bugs, follow the roadmap, and participate in the WDS community.
4+
5+
---
6+
7+
## Where to Ask Questions
8+
9+
Use **Discussions** when you:
10+
11+
- Need troubleshooting help but are not sure it is a bug.
12+
- Have questions about features, platforms, or settings.
13+
- Want to share general feedback or ideas.
14+
15+
Before posting:
16+
- Browse existing topics in the relevant support or Q&A category.
17+
- Search by keyword — your question may already have an answer.
18+
- Keep titles descriptive so others can find similar discussions.
19+
20+
➡️ [Browse Discussions](https://github.com/World-Domination-Software/Projects/discussions)
21+
22+
---
23+
24+
## Where to Report Bugs
25+
26+
Use **Issues** when you have a clear, reproducible problem:
27+
28+
- A repeatable gameplay or UI bug.
29+
- A crash, hard freeze, or save corruption.
30+
- A multiplayer connectivity problem.
31+
- Significant performance problems that persist after basic troubleshooting.
32+
33+
If you are unsure whether to open an Issue or a Discussion — start with a Discussion. Maintainers can convert it to an Issue if needed.
34+
35+
➡️ See [[Bug-Reporting]] for templates and guidance.
36+
37+
---
38+
39+
## Where to Follow the Roadmap
40+
41+
Our roadmap lives in the **Roadmap** category of Discussions. This is where we share planned work and where the community can comment and react.
42+
43+
➡️ [Roadmap Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap)
44+
45+
To follow updates:
46+
1. Open the Roadmap category.
47+
2. Use the **Watch / notification** control on the page to follow new posts and comments.
48+
3. React with emojis for quick feedback, or comment when you have specific input.
49+
50+
See also [[Roadmap]] for an overview of current focus areas.
51+
52+
---
53+
54+
## How to Participate
55+
56+
We welcome community participation. To keep discussions useful and professional:
57+
58+
- Be specific and constructive — general feedback is helpful; specific examples are better.
59+
- Stay on topic within categories. Support questions belong in support categories; ideas in the ideas or roadmap categories.
60+
- Search before posting to avoid duplicate threads.
61+
- Report bugs with the detail described in [[Bug-Reporting]] so they can be investigated efficiently.
62+
63+
---
64+
65+
**[[Home]] · [[Bug-Reporting]] · [[Support]] · [[Roadmap]] · [[FAQ]]**

wiki/FAQ.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# FAQ
2+
3+
Frequently asked questions about WDS projects and this repository.
4+
5+
---
6+
7+
## General
8+
9+
### Where do I report bugs?
10+
11+
Use the issue templates in this repository. Select the template that best matches your problem (bug report, crash report, performance issue, or multiplayer issue). See [[Bug-Reporting]] for guidance on writing a useful report.
12+
13+
➡️ [Open an Issue](https://github.com/World-Domination-Software/Projects/issues/new/choose)
14+
15+
### Which platforms are supported?
16+
17+
We aim to support PC (Windows, Linux, Steam Deck) and mobile platforms (Android, iOS) where possible. Exact support varies by project and release. Check each project's [[Projects|page in the project directory]] for current platform status.
18+
19+
### How do I share feedback or ideas?
20+
21+
Use [GitHub Discussions](https://github.com/World-Domination-Software/Projects/discussions) for ideas, general feedback, and suggestions. For well-defined feature requests, use the **Feature request** issue template.
22+
23+
### Can I contribute code or content?
24+
25+
Yes, in some cases. Please read [CONTRIBUTING.md](https://github.com/World-Domination-Software/Projects/blob/main/CONTRIBUTING.md) before starting work, and open an issue or discussion for larger proposals before implementing.
26+
27+
---
28+
29+
## Bug Reports and Issues
30+
31+
### How do I check if a bug is already known?
32+
33+
- Search existing [issues](https://github.com/World-Domination-Software/Projects/issues) with relevant keywords.
34+
- Look for issues labeled `known-issue` or `confirmed`.
35+
- Browse the relevant project's Discussions support category.
36+
37+
### Should I open an Issue or a Discussion?
38+
39+
If you have a clear, reproducible bug — open an Issue using the appropriate template. If you are not sure yet whether it is a bug, or you need help troubleshooting first — start a Discussion. Maintainers can convert a Discussion to an Issue if needed.
40+
41+
---
42+
43+
## Troubleshooting
44+
45+
### Where is the troubleshooting guide?
46+
47+
See [[Troubleshooting-Index]] for a symptom-based guide covering common issues across all projects.
48+
49+
### The troubleshooting guide didn't fix my problem. What next?
50+
51+
1. Check if there is a project-specific troubleshooting page (linked from each project's landing page).
52+
2. Search existing [issues](https://github.com/World-Domination-Software/Projects/issues) and [discussions](https://github.com/World-Domination-Software/Projects/discussions).
53+
3. Post in the support Discussions category for the relevant project (see [[Support]]).
54+
4. If it is a clear bug, file an issue via [[Bug-Reporting]].
55+
56+
---
57+
58+
## Roadmap and Updates
59+
60+
### Where can I see what's planned?
61+
62+
The roadmap is hosted in GitHub Discussions so the community can follow and participate:
63+
64+
➡️ [Roadmap Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap)
65+
66+
See also [[Roadmap]] for context on how we use it.
67+
68+
### How do I stay notified about updates?
69+
70+
- Watch the repository (select notification level under **Watch** at the top of the repo page).
71+
- Subscribe to specific roadmap discussion threads you care about.
72+
- Follow the Releases section of this repository for published builds.
73+
74+
---
75+
76+
**[[Home]] · [[Troubleshooting-Index]] · [[Bug-Reporting]] · [[Support]] · [[Roadmap]]**

wiki/Game-Servers-Panel-FAQ.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Game Servers Panel – FAQ
2+
3+
← Back to [[Game-Servers-Panel]]
4+
5+
---
6+
7+
## General
8+
9+
### What is Game Servers Panel?
10+
11+
Game Servers Panel is a web-based management interface for game server infrastructure. It lets operators deploy, monitor, configure, and control game server instances from a central dashboard, without needing direct command-line access to the server hosts.
12+
13+
### What types of game servers can be managed?
14+
15+
Game Servers Panel is designed to work with WDS-supported game server types. Support for specific games and server types is documented in the panel itself. Ask in [Game Servers Panel Support Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/game-servers-panel-support) for specifics.
16+
17+
### Is it cloud-hosted or self-hosted?
18+
19+
Game Servers Panel is self-hosted — you install and run the panel and agents on your own infrastructure. WDS does not manage your panel instance.
20+
21+
---
22+
23+
## Setup and Access
24+
25+
### How do I install the panel?
26+
27+
Installation documentation is included in the panel release package. For the latest guidance, see the [release notes](https://github.com/World-Domination-Software/Projects/releases) or ask in [Game Servers Panel Support Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/game-servers-panel-support).
28+
29+
### How do I add a new server to the panel?
30+
31+
Install the agent process on the server host, configure it with your panel address and authentication token, then register it in the panel dashboard. Detailed steps are in the panel's documentation.
32+
33+
### Can multiple operators manage the same panel?
34+
35+
Yes. Role-based access control allows you to create accounts with different permission levels (viewer, operator, administrator).
36+
37+
---
38+
39+
## Operations
40+
41+
### Do configuration changes require a server restart?
42+
43+
Most configuration changes require a server restart to take effect. The panel will indicate when a restart is needed after applying changes.
44+
45+
### Can I schedule maintenance windows?
46+
47+
Yes. The panel supports scheduled lifecycle actions including maintenance windows and restarts.
48+
49+
### How do I access server logs?
50+
51+
Server logs are accessible directly from the panel's **Logs and Diagnostics** section for any connected server.
52+
53+
---
54+
55+
## Technical
56+
57+
### How do I report a bug?
58+
59+
See [[Bug-Reporting]] for how to choose the right template and what to include.
60+
61+
### Something is wrong with the agent connection. What should I check?
62+
63+
See [[Game-Servers-Panel-Troubleshooting]] for a step-by-step agent connectivity guide.
64+
65+
---
66+
67+
**[[Game-Servers-Panel]] · [[Game-Servers-Panel-Troubleshooting]] · [[Support]] · [[Bug-Reporting]]**
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Game Servers Panel – Overview
2+
3+
**Type:** Hosting / Infrastructure | **Developer:** World Domination Software LLC
4+
5+
← Back to [[Game-Servers-Panel]]
6+
7+
---
8+
9+
## What Is Game Servers Panel?
10+
11+
Game Servers Panel is a web-based application for deploying, monitoring, and administering game server instances. It provides a centralized interface that gives operators control over their hosting environment without requiring deep command-line expertise.
12+
13+
## Purpose
14+
15+
Running game servers reliably is operationally complex. Game Servers Panel simplifies this by:
16+
17+
- Providing a single dashboard for all hosted server instances.
18+
- Reducing the operational burden of manual server administration.
19+
- Making server management accessible to operators who are not system administrators.
20+
21+
## Features
22+
23+
| Feature | Description |
24+
|---|---|
25+
| **Server deployment** | Spin up new server instances quickly from a managed interface. |
26+
| **Monitoring and status** | View live status, resource usage, and health for each server. |
27+
| **Configuration management** | Edit and apply server configuration without direct file access. |
28+
| **Access control** | Role-based permissions for operators and administrators. |
29+
| **Logs and diagnostics** | Access server logs from the panel for troubleshooting. |
30+
| **Lifecycle controls** | Start, stop, restart, and schedule server maintenance windows. |
31+
32+
## Architecture
33+
34+
Game Servers Panel is a web-based application with a server-side backend that communicates with lightweight agent processes running on each hosted machine. The panel UI is served from a central host; agents relay commands and telemetry between the panel and the underlying servers.
35+
36+
Key components:
37+
38+
- **Panel web application** – User-facing dashboard and API layer.
39+
- **Agent process** – Lightweight service installed on each server host, handling lifecycle and telemetry.
40+
- **Communication layer** – Secure channel between the panel and agents.
41+
42+
## Development Status
43+
44+
| Area | Status |
45+
|---|---|
46+
| Core panel and agent | Active development |
47+
| Monitoring and dashboards | Available |
48+
| Role-based access control | Available |
49+
| Extended log analysis | Planned |
50+
51+
For current priorities, see the [Roadmap discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap).
52+
53+
---
54+
55+
**[[Game-Servers-Panel]] · [[Game-Servers-Panel-Troubleshooting]] · [[Game-Servers-Panel-FAQ]]**

0 commit comments

Comments
 (0)