This is the visual-learner plan for the documentation. Capture everything with a test instance and fake/test player data. Never show a real bot token, Discord user token, email address, private server name, player IP, or sensitive ID. Blur or crop them first.
Put every image in:
docs-site/public/images/screenshots/
Each path below is relative to that folder. For example, the first file goes at docs-site/public/images/screenshots/getting-started/01-dashboard-instance-switcher.png. Keep the exact names. After you add them, tell us and they can be placed next to the relevant instructions without changing their public URLs.
Use PNG. Capture the useful control and page title at a readable zoom; avoid giant empty margins and browser chrome.
| File | Show it on | Capture |
|---|
getting-started/01-dashboard-instance-switcher.png | Start guide, step 1 | Sidebar with Instance Switcher open and a selected test instance. |
getting-started/02-instance-selected-dashboard.png | Zero-to-live, Part 4 | Dashboard overview for the correct selected instance. |
getting-started/03-setup-start-fresh.png | Zero-to-live, Part 4 | Setup screen showing Start fresh before a token is entered. |
getting-started/04-setup-bot-name-field.png | Zero-to-live, Part 4 | Setup form with fake bot name and a redacted token field. |
getting-started/05-dashboard-runtime-actions.png | Zero-to-live, Part 4 | Status plus Start, Stop, Restart, Provision / Deploy controls. |
getting-started/06-config-main-settings.png | Zero-to-live, Part 5 | Config top fields: bot name and singular/plural labels. |
getting-started/07-config-intent-switches.png | Zero-to-live, Part 5 | Kompendium intent switches with no secrets. |
getting-started/08-modules-overview.png | Zero-to-live, Part 6 | Modules page with core and optional modules. |
getting-started/09-discord-test-channel.png | Zero-to-live, Part 7 | Private Discord test channel with bot member visible. |
getting-started/10-first-test-success.png | Zero-to-live, Part 8 | End-to-end spawn, catch, and inventory test. |
| File | Show it on | Capture |
|---|
discord-developer-portal/01-applications-list.png | Portal walkthrough opening | Applications list with a test app highlighted. |
discord-developer-portal/02-new-application.png | Zero-to-live, Part 1 | New Application dialog using a fake name. |
discord-developer-portal/03-general-information.png | Portal, General Information | Name, icon, and ID area; blur every ID. |
discord-developer-portal/04-application-icon-description.png | Portal, General Information | Profile and description fields after branding a test app. |
discord-developer-portal/05-bot-page-navigation.png | Zero-to-live, Part 1 | Portal sidebar with Bot selected. |
discord-developer-portal/06-bot-profile.png | Portal, Bot profile | Bot username and avatar controls. |
discord-developer-portal/07-token-redacted.png | Zero-to-live, token | Token section with value completely covered. |
discord-developer-portal/08-reset-token-warning.png | Portal, token | Reset-token confirmation only; never reveal the token. |
discord-developer-portal/09-privileged-intents.png | Zero-to-live, Part 2 | Privileged Gateway Intents labels and switches. |
discord-developer-portal/10-installation-contexts.png | Portal, Installation | Installation Contexts with Guild Install enabled. |
discord-developer-portal/11-install-link-setting.png | Portal, Installation | Discord Provided Link setting. |
discord-developer-portal/12-guild-scopes.png | Zero-to-live, Part 3 | bot and applications.commands scopes. |
discord-developer-portal/13-bot-permissions.png | Portal, permissions | Recommended permissions selected. |
discord-developer-portal/14-discord-invite-confirmation.png | Zero-to-live, Part 3 | Invite/authorization screen for a test server. |
| File | Show it on | Capture |
|---|
dashboard/01-sidebar-map.png | Dashboard tour opening | Full dashboard sidebar with destinations visible. |
dashboard/02-dashboard-status.png | Dashboard tour, status | Runtime health/status area. |
dashboard/03-sync-commands.png | Zero-to-live, Part 8 | Sync commands control and normal post-click state. |
dashboard/04-config-currency.png | Dashboard Config, currency | Currency setting after Currency is enabled. |
dashboard/05-config-admin-access.png | Dashboard Config, access | Co-owner/admin-server/staff-role fields using fake IDs. |
dashboard/06-admin-panel-entry.png | First collectible, opening | Dashboard link that opens Admin panel. |
dashboard/07-admin-panel-home.png | Admin panel overview | Admin home grouped model sections. |
dashboard/08-admin-search.png | Admin panel search | Search box and safe example query. |
dashboard/09-admin-filter.png | Admin panel records | List page with filter controls open. |
dashboard/10-admin-record-detail.png | Admin panel records | Detail/edit form with Save controls. |
dashboard/11-data-backup.png | Zero-to-live, checklist | Data export/backup action. |
dashboard/12-logs-activity.png | Zero-to-live, Part 8 | Logs & Activity with non-sensitive sample events. |
| File | Show it on | Capture |
|---|
modules/01-modules-enabled-state.png | Modules overview | Enabled and disabled optional module state. |
modules/02-module-manage-button.png | Modules overview | Module card and its Manage button. |
modules/03-module-admin-header.png | Module management | Full-page module settings header, toggle, and Back to modules. |
modules/04-command-picker.png | Custom responses | Compact command picker expanded. |
modules/05-discord-response-edit-mode.png | Custom responses | Discord-style reply in edit mode. |
modules/06-discord-response-preview-mode.png | Custom responses | Same reply with preview switch on and realistic variable values. |
modules/07-embed-field-editor.png | Custom embeds | Editable embed title, description, and fields. |
modules/08-button-color-cycle.png | Custom embeds | Button label and color-cycle control. |
| File | Show it on | Capture |
|---|
spawn/01-discord-spawn-channel-command.png | Zero-to-live, Part 7 | /spawn channel in a private test channel. |
spawn/02-spawn-overview.png | Spawn System guide | Main Spawn page with major sections. |
spawn/03-catch-method.png | Spawn controls, catch method | Catch-method selector and explanation. |
spawn/04-timing-settings.png | Spawn controls, timing | Minimum/maximum time and timeout fields. |
spawn/05-activity-controls.png | Spawn controls, activity | Activity/anti-camping controls. |
spawn/06-weighting-settings.png | Spawn controls, weighting | Rarity/weighting controls. |
spawn/07-test-spawn.png | Zero-to-live, Part 7 | Live test drop with safe artwork. |
spawn/08-catch-success.png | Zero-to-live, Part 8 | Valid catch confirmation. |
| File | Show it on | Capture |
|---|
cards/01-card-studio-overview.png | Card Studio opening | Canvas, layer list, and inspector. |
cards/02-create-template.png | Card Studio, create template | Template dropdown, Create new, name/canvas fields. |
cards/03-template-layer-inspector.png | Card Studio, inspector | Selected artwork or text layer controls. |
cards/04-font-library.png | Card Studio, Font Library | Font upload/library area. |
cards/05-collectibles-list.png | First collectible, opening | Admin Collectibles list with a test row. |
cards/06-add-collectible-identity.png | First collectible, identity | Name, short name, emoji, catchable names fields. |
cards/07-add-collectible-artwork.png | First collectible, artwork | Collection and spawn artwork upload fields. |
cards/08-collectible-card-preview.png | First collectible, preview | Saved collectible with Card preview. |
| File | Show it on | Capture |
|---|
using-kompendium/01-slash-command-picker.png | Discord commands | Slash-command picker for the bot. |
using-kompendium/02-inventory-collection.png | Collectibles and inventory | Test player collection/inventory response. |
using-kompendium/03-trade-flow.png | Trade module | Safe test trade interaction. |
using-kompendium/04-currency-balance.png | Economy module | Balance reply with fake currency value. |
using-kompendium/05-pack-opening.png | Packs and auctions | Pack-opening response. |
using-kompendium/06-auction-listing.png | Packs and auctions | Auction/listing interface or reply. |
using-kompendium/07-import-job-log.png | Imports and migration | Import job/status using test data. |
using-kompendium/08-troubleshooting-status.png | Discord troubleshooting | Non-sensitive error/status example and inspection area. |
- Reuse the same test bot, example server, and example collectible where possible so the guide feels connected.
- Prefer readable controls over a full-screen capture with tiny text.
- Include the page title and the next button the reader must press.
- Use fake tokens and IDs; a black rectangle is better than a real secret.
- Never edit a screenshot to imply a setting exists when it does not.
- If UI changes later, replace the image with the same filename so its URL remains stable.
This checklist contains 60 screenshots, deliberately above the minimum requested visual coverage.