Expand user docs: captains, players, authors, orgs - #315
Draft
bomzheg wants to merge 3 commits into
Draft
Conversation
Add user-story style pages in the same tone as the existing docs, covering
both the telegram bot and the web UI:
- captains: adding players, moving the team to another chat, in-team
permissions, and a captain FAQ; waivers page gets the web flow and
the "who besides the captain" section
- players: joining and leaving a team, how a game actually goes, and
what the approval ("аппрув") is for
- authors: creating a game, writing levels, putting levels into a game,
scheduling the start, inviting orgs and setting their permissions
- orgs: spying on a running game from the bot and from the site
Also link the new pages from nav, index and the existing team pages.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0184gZVazPeoE28y15R8o431
The docs pages so far described the bot in prose. Shoot the dialogs from the aiogram_dialog preview page instead: it renders every dialog window as a telegram message with its real texts and inline keyboard, so the screenshots match the code and can be regenerated when the dialogs change. 36 screenshots wired into the captain, player, author and org pages: the captain's bridge (players list, player permissions, kick confirmation, rename, chat transfer), the main menu, my team, teams list, approval screen, completed game card, the whole level and game writing flow, schedule calendar/time/confirm, org list and org permissions, and the spy menus. docs/tools/dialog-shots holds the script, the state -> file mapping and a README describing the two-step workflow. Where a screenshot now shows the real message, the invented sample output is dropped (spy menus, game level list, level menu). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0184gZVazPeoE28y15R8o431
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds 11 new pages to the Antora docs in the same style as the existing ones (Russian, user-story / FAQ tone, bot + web side by side), plus 36 bot screenshots and links from
nav.adoc,index.adocand the existing team pages. Nothing about the admin panel.Капитану (main priority)
setup_team/add_players.adoc— all five ways to add a player:/add_in_teamby reply, the button when someone joins the chat, the captain's bridge user-request button, web invite / hard add, and a player's own join request. Plus the error messages people actually hit.setup_team/move_chat.adoc— moving a team to another chat: prerequisites (supergroup, bot in chat, a message so the bot knows the chat, no other team), the flow, what happens to the old chat, and every error the handler can produce. Captain-only.setup_team/permissions.adoc— each of the five team permissions, what it actually unlocks, what stays captain-only, and role/emoji as cosmetics.setup_team/captain_faq.adoc— rename/motto, kicking, rejoin history, one-team rule,/who_thereand/which_team, web-created teams, forum merge, and why the bot goes silent during a game.setup_team/waivers.adoc(existing page) — added who besides the captain may submit waivers, the web waivers flow, and a short FAQ.Игроку
player/join_team.adoc— being added, accepting an invite, applying to a team from the site, how to check you're in a team.player/leave_team.adoc—/leave, the menu button, the web button, and what leaving does to waivers/history.player/play.adoc— the whole game: waiver check, the pre-start message, levels and hints in the team chat, key format and every bot answer (correct / wrong / duplicate / bonus / bonus hint), the web play page, push notifications, and what is disabled while a game runs.player/promotion.adoc— what the approval is for and how to get / give one.Автору
author/game-create.adoc— bot and web paths, game statuses, zip import.author/level-create.adoc— the level dialog step by step (id, keys, effect keys, timers, hints) and the same in the web editor.author/game-levels.adoc— putting levels into a game, ordering, unlinking, pre-game checks.author/game-schedule.adoc— starting waivers, picking date/time, what happens automatically, cancelling/moving.author/game-orgs.adoc— inviting orgs in bot and web, what each org permission means, removing/restoring, sending levels for testing.Организатору
org/spy.adoc— new nav section: spy menu, current levels, key log, level-up notifications, the web spy panel and scenario tabs.Screenshots
The bot screenshots are taken from the aiogram_dialog preview page rather than by hand: it renders every dialog window as a telegram message with its real texts and inline keyboard, so what the docs show matches the dialog definitions and can be regenerated when they change.
36 shots are wired in: the captain's bridge (players list, player permissions, kick confirmation, rename, chat transfer), main menu, my team, teams list, approval screen, completed game card, the whole level and game writing flow, schedule calendar / time / confirm, org list and org permissions, and the three spy screens.
docs/tools/dialog-shots/holds the script, the state → file mapping and a README with the two-step workflow. Where a screenshot now shows the real message, the hand-written sample output it replaced was dropped (spy menus, game level list, level menu).Web UI screenshots are not included — capturing those needs a running backend.
Checks
Built the docs locally with Antora: no xref, page or list warnings, and every
image::target resolves to a published attachment. The remainingtarget of image not found: ../_attachments/...messages are Antora's validator being noisy —masterproduces them for its existing images too, and the images render correctly in the generated site.🤖 Generated with Claude Code
https://claude.ai/code/session_0184gZVazPeoE28y15R8o431