Skip to content

Restructure MUME Wiki for Newbie Onboarding - #46

Merged
nschimme merged 11 commits into
mainfrom
wiki-reorganize-newbie-onboarding-13997782053986515008
Sep 8, 2026
Merged

Restructure MUME Wiki for Newbie Onboarding#46
nschimme merged 11 commits into
mainfrom
wiki-reorganize-newbie-onboarding-13997782053986515008

Conversation

@nschimme

@nschimme nschimme commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

This change restructures the MUME wiki to address student survey feedback and streamline onboarding for first-time MUD players. Key improvements include:

  • Quick Start & Command Cheat Sheet (Quick_Start.md): Created a dedicated onboarding gateway with a First 15 Minutes Checklist (change wimpy 15, change spam fight on), a tutorial inventory warning, categorized command tables (give [item] [person], draw/sheathe, wear, eat/drink, ask <NPC> <topic>, order), death/corpse recovery tips, and official Discord integration.
  • Home & Navigation Funnel (index.md, config.ts, Guides.md): Promoted "Quick Start" to the primary action button on the home page, top header navigation, and bottom recirculation include footer across all pages.
  • Progressive Guides Index (guides.md): Restructured player guides into progressive learning tiers ("First Hour Survival", "Adventuring & Character Growth", "Class & Race Guides").
  • Up-to-Date Help Pages: Updated Spam.md, Prompt.md, Compact.md, and Brief.md with official MUME syntax (change spam <field> [on|off], change prompt). Added VitePress tip callout banners to core pages (Basics.md, Combat.md, Death.md, Quest.md, FAQ1.md, FAQ3.md).

PR created automatically by Jules for task 13997782053986515008 started by @nschimme

Summary by Sourcery

Restructure the wiki around a progressive Quick Start onboarding experience for new MUME players.

New Features:

  • Add a Quick Start and command cheat sheet to guide new players through initial setup, core commands, survival, death recovery, quests, and community support.

Bug Fixes:

  • Correct and clarify documented syntax for spam, prompt, compact, and related commands, and remove the outdated Brief help page.

Enhancements:

  • Restructure the guides into progressive onboarding, adventuring, class/race, reference, and advanced sections.
  • Make Quick Start the primary onboarding path throughout the home page, navigation, and guide links.
  • Add contextual onboarding tips to core basics, combat, death, quest, and FAQ pages.

Documentation:

  • Add official MUME Discord access to site navigation and onboarding resources.

@google-labs-jules

Copy link
Copy Markdown

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@sourcery-ai

sourcery-ai Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

The PR introduces a Quick Start onboarding gateway, routes site navigation toward it, restructures the guides into progressive learning tiers, and refreshes core command/help pages with current syntax, cross-links, and beginner-focused callouts.

File-Level Changes

Change Details Files
Added a dedicated first-hour onboarding gateway and command reference for new MUME players.
  • Created a first-15-minutes setup checklist covering wimpy, combat spam, character inspection, navigation, and tutorial inventory changes.
  • Added categorized syntax tables for movement, equipment, survival, NPC interaction, combat, communication, death recovery, quests, and Discord support.
  • Added warnings and practical tips for starter-area dangers, room descriptions, corpses, and community assistance.
docs/pages/Quick_Start.md
Reworked site navigation to funnel new players toward Quick Start.
  • Promoted Quick Start in the home hero action, feature cards, and global header navigation.
  • Added Quick Start to the guides footer include and linked the official Discord from site social links.
docs/index.md
docs/.vitepress/config.ts
docs/includes/Guides.md
Organized the guides index into progressive learning stages.
  • Grouped onboarding resources under First Hour Survival.
  • Separated follow-on content into Adventuring & Character Growth, Class & Race Guides, featured/reference material, and advanced strategy.
  • Updated descriptions and numbering to reflect the new learning path.
docs/guides.md
Updated command reference pages to use current MUME change syntax and improve beginner guidance.
  • Revised Spam, Prompt, Compact, and Brief usage and field documentation.
  • Added cross-links to Quick Start and related command pages.
  • Added tip or warning callouts to Basics, Combat, Death, FAQ, and Quest pages.
docs/pages/Spam.md
docs/pages/Prompt.md
docs/pages/Compact.md
docs/pages/Brief.md
docs/pages/Basics.md
docs/pages/Combat.md
docs/pages/Death.md
docs/pages/FAQ1.md
docs/pages/FAQ3.md
docs/pages/Quest.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 3 issues

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="docs/pages/Death.md" line_range="12" />
<code_context>
+Dying is a normal part of learning MUME:
+- **Retrieving Gear**: Return to your `corpse` and type `get all corpse`.
+- **Ask for Help**: If you died in a dangerous area, use `narrate` or `tell` to ask friendly players for help. Experienced players are happy to escort you back!
+- **Newbie Kits**: Good-aligned characters below level 6 receive a free newbie kit on re-login after death.
+For more first-hour survival tips, see the [**Quick Start Guide**](./Quick_Start.md).
+:::
</code_context>
<issue_to_address>
**issue:** The tip tells new players that good-aligned characters below level 6 receive a free newbie kit on re-login after death, but newbie kits are granted by praying to the Ainur and asking an immortal; they are not automatically supplied on re-login.

**Triggers:** When a new player dies and logs back in expecting the promised automatic kit.

**Suggested fix:** State that eligible Free People characters can request another kit after death by praying to the Ainur, rather than promising an automatic re-login kit.

```suggestion
- **Newbie Kits**: Eligible Free People characters below level 6 can request another newbie kit after death by praying to the Ainur and asking an immortal.
```
</issue_to_address>

### Comment 2
<location path="docs/pages/Quick_Start.md" line_range="143" />
<code_context>
+Death is a learning experience in MUME, not the end of your adventure!
+
+1. **Your Body Becomes a Corpse**:
+   When you die, your worn and carried equipment stays on your `corpse` at the location where you fell.
+2. **Re-appearing in Mandos or Town**:
+   You will reappear safely in a starter hall or town.
</code_context>
<issue_to_address>
**issue:** The guide states that worn and carried equipment stays on a corpse whenever the player dies, but death-trap deaths do not provide a recoverable corpse and existing death guidance also warns that equipment can be taken before the player returns.

**Triggers:** When a new player dies in a death trap or returns after another player or creature has removed items.

**Suggested fix:** Qualify this with the death-trap exception and explain that corpse recovery is not guaranteed.

```suggestion
   In most cases, your worn and carried equipment stays on your `corpse` at the location where you fell, but death-trap deaths do not leave a recoverable corpse, and corpse recovery is not guaranteed.
```
</issue_to_address>

### Comment 3
<location path="docs/pages/Quick_Start.md" line_range="67" />
<code_context>
+| View worn gear | **`equipment`** | `eq` | Displays items currently worn or held. |
+| View carried gear | **`inventory`** | `i` | Displays items inside your bags or hands. |
+| Hold a weapon | **`wield`** | `wield sword` | Wields a weapon in your hand. |
+| Draw / Sheathe | **`draw`** / **`sheathe`** | `draw sheath` / `sheathe` | Draws or sheathes a weapon (requires a sheath/scabbard). |
+| Wear armor | **`wear`** | `wear shield` / `wear all` | Wears clothing, armor, or shields. |
+| Belt items | **`wear`** | `wear lantern belt` | Attaches lanterns, flasks, or pouches to your belt. |
</code_context>
<issue_to_address>
**nitpick:** The equipment table says drawing or sheathing requires a sheath/scabbard, but `draw` also supports drawing bows worn across the back and weapons directly from inventory, so the requirement incorrectly tells players those valid uses are unavailable.

**Triggers:** When a new player tries to draw a bow or an unsheathed weapon from inventory.

**Suggested fix:** Say that a sheath is needed for sheathed weapons, while bows and inventory weapons can also be drawn directly.

```suggestion
| Draw / Sheathe | **`draw`** / **`sheathe`** | `draw sheath` / `sheathe` | Draws or sheathes a weapon; a sheath is needed for sheathed weapons, while bows and inventory weapons can also be drawn directly. |
```
</issue_to_address>

Sourcery assessment

Approval pending. 2 findings to address first.

Blocking findings: docs/pages/Death.md:12, docs/pages/Quick_Start.md:143


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

Comment thread docs/pages/Death.md Outdated
Comment thread docs/pages/Quick_Start.md Outdated
Comment thread docs/pages/Quick_Start.md Outdated
sourcery-ai[bot]
sourcery-ai Bot previously approved these changes Sep 8, 2026

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sourcery assessment

Approved.

@sourcery-ai
sourcery-ai Bot dismissed their stale review September 8, 2026 14:15

Sourcery withdrew this approval because it has stopped reviewing this pull request.

@sourcery-ai

sourcery-ai Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Sourcery has withdrawn its approval of this pull request. It auto-reviews a pull request 5 times, and this push is past that limit, so the approval no longer reflects code Sourcery has read.

Comment @sourcery-ai review to get a fresh review, which can approve again.

Re-reviews, rate limits and approvals

@nschimme
nschimme merged commit 554494b into main Sep 8, 2026
2 checks passed
@nschimme
nschimme deleted the wiki-reorganize-newbie-onboarding-13997782053986515008 branch September 8, 2026 14:31
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