Skip to content

docs: restructure by task, and document the areas that had no docs - #4

Open
vRaphael wants to merge 1 commit into
Guildyapper:masterfrom
vRaphael:docs/restructure-en
Open

vRaphael wants to merge 1 commit into
Guildyapper:masterfrom
vRaphael:docs/restructure-en

Conversation

@vRaphael

@vRaphael vRaphael commented Sep 4, 2026

Copy link
Copy Markdown

The complete refresh we talked about. One PR, as you asked.

The structural problem this fixes

The tree split Discord Bot from the feature sections, organising by surface. But the product isn't split that way — /configure server has a "Manage on Website" button, and almost every task exists in both places. So a reader had to already know which surface a capability lived on before they could find it.

That produced real symptoms: configuration was documented in two places that didn't reference each other, and Guild League was one paragraph inside Signups and nothing else.

Regrouped by job: Start Here · Events · Scores and VOD · Guild Tracker · Public Data · Configuration · Community · Reference. Each page covers a task and shows both paths to it.

What had no documentation at all

Sixteen new pages. The ones most worth your eye:

  • VOD Reviews — the site calls it the flagship Premium feature; the word "VOD" appeared nowhere in the docs, in either locale.
  • Guild League — the command's vc, interval and nodewar-slots options, the four officer actions, and the public match browser and standings.
  • Event Types and Signup Profiles — including Siege, Blue Battlefield and War of the Roses, none of which were mentioned anywhere.
  • Platoons and Function Roles — function roles are signup labels, not Discord roles, and that distinction was undocumented.
  • Waitlist and Priority — the priority stack, the dynamic class types, and /priority view, which is the tool that answers "why did they get in and I didn't".
  • Platoon Builder, Server Settings (the five Discord tabs against the seven web tabs), the five public data pages, a glossary, and an end-to-end first node war walkthrough.

Five pages retired

bot/commands, bot/configuration, features/parties-and-waitlist, features/tierlists-and-stats and website/overview. Each was removed only after its replacement existed, and each removal got a review whose only job was proving nothing was lost — which caught two things that had been left behind and brought them back.

How the commands were verified

Against Discord's own command picker on a live Guild server, not against the bot's /help. That matters: /help omits /signup gvg, /signup list, /scores menu, /scores upload and /player profile, and lists /member register and /attendance update, which don't exist. The reference now matches the 36 commands a Guild server actually registers.

Two command groups are not verified and are marked as depending on server type: the Community commands and the Trial commands. They don't appear on a Guild server, so I had nothing to check them against.

Notes

Written with AI assistance, verified command by command against the running product.

🤖 Generated with Claude Code

The tree split "Discord Bot" from the feature sections, organising by
surface. The product is not split that way — /configure server carries a
"Manage on Website" button, and almost every task exists in both places
— so a reader had to know which surface a capability lived on before
they could find it. Configuration was documented twice; Guild League was
one paragraph inside Signups and nothing else.

Regrouped by job: Start Here, Events, Scores and VOD, Guild Tracker,
Public Data, Configuration, Community, Reference. Each page covers a
task and shows both paths to it.

Sixteen pages added for areas that had no documentation at all: VOD
Reviews, Guild League's web side, event types and signup profiles,
platoons and function roles, waitlist and priority, the Platoon Builder,
the website settings, the five public data pages, a glossary, an
end-to-end first node war walkthrough, and a 404.

Five pages retired, each after its replacement existed and its content
was verified as migrated: bot/commands, bot/configuration,
features/parties-and-waitlist, features/tierlists-and-stats and
website/overview.

Every command was checked against Discord's own command picker on a live
Guild server rather than against the bot's built-in help, which omits
five commands that exist and lists two that do not.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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