Skip to content

README: add Screenshots section — what the panel actually looks like#42

Merged
AdaInTheLab merged 1 commit into
mainfrom
docs/readme-screenshots
Apr 26, 2026
Merged

README: add Screenshots section — what the panel actually looks like#42
AdaInTheLab merged 1 commit into
mainfrom
docs/readme-screenshots

Conversation

@AdaInTheLab
Copy link
Copy Markdown
Collaborator

Summary

First-time visitors to the GitHub repo currently have to imagine what KC's panel looks like from the feature bullet list. This PR drops in a Screenshots section right after Features with a tour of 8 panels, each with a small caption explaining what you'd reach for it for.

Previously these screenshots lived in `KitsuneCommandDocs/static/img/ss/` — moved to the main repo since that's where prospective installers usually land first (and where the README actually renders to a wider audience than the docs site).

What's covered

Section Caption gist
Server Control Live stats, save/restart/shutdown, system info
Server Update SteamCMD auto-update with sticky `serverconfig.xml`
Config Editor Form-driven `serverconfig.xml` editing
Mods Manager Browse Nexus + upload, handles messy zip shapes
Backups Scheduled + ad-hoc world saves
Item Database Search all 26k+ items
Settings → Discord Bot integration in one tab
Settings → Account Change password + escape hatch

File layout

`docs/screenshots/.png` — same convention as the existing `docs/banner.png` and `docs/troubleshooting.md`. Eight files total, ~1.1 MB combined.

Test plan

  • All 8 image links resolve in the rendered README on GitHub
  • Captions describe the panel without overselling
  • Section sits between Features and Tech Stack so it flows naturally for someone reading top-to-bottom

🤖 Generated with Claude Code

Drops a screenshots-of-the-panel section right after Features so
first-time visitors can see what KC actually looks like before they
commit to installing. Eight panels covered, each with a small caption
explaining what you'd reach for it for:

  - Server Control (live stats + restart/shutdown)
  - Server Update (SteamCMD auto-update + sticky serverconfig.xml)
  - Config Editor (form-driven serverconfig editing)
  - Mods Manager (Nexus discover + upload, handles messy zip shapes)
  - Backups (scheduled + ad-hoc world saves)
  - Item Database (browse all 26k+ items)
  - Settings → Discord (bot integration in one tab)
  - Settings → Account (change password + kcresetpw escape hatch)

Images live at docs/screenshots/ alongside the existing banner.png and
troubleshooting docs. Same convention as everything else under docs/.

(Originally Ada had these in KitsuneCommandDocs/static/img/ss/ — moved
to the main repo since that's where most prospective installers actually
land first.)
@AdaInTheLab AdaInTheLab merged commit 752177a into main Apr 26, 2026
2 checks passed
@AdaInTheLab AdaInTheLab deleted the docs/readme-screenshots branch April 26, 2026 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant