Skip to content

Revise Abbreviations page content and description#27

Merged
nschimme merged 2 commits into
mainfrom
nschimme-patch-1
May 24, 2026
Merged

Revise Abbreviations page content and description#27
nschimme merged 2 commits into
mainfrom
nschimme-patch-1

Conversation

@nschimme

@nschimme nschimme commented May 24, 2026

Copy link
Copy Markdown
Contributor

Updated the description for the Abbreviations page and restructured the content to improve clarity and organization.

Description

Related Issue

Checklist

  • Wiki Rules: I have followed the Content Rules (mortal knowledge only) and Spoiler Rules (using ::: details Spoiler) as defined in the Contributing Guide.
  • Content Accuracy: I have verified the information added/changed is accurate to the game.
  • Visual Check: I have verified that the page renders correctly (no broken tables, lists, or styling).
  • Local Build: (For coders) Ran docker compose up --build wiki (or npm run docs:build) and verified changes locally.
  • Index Pages: Updated top-level index pages (e.g., docs/guides.md, docs/classes.md) if a major new page was added.

Summary by Sourcery

Restructure and expand the Abbreviations documentation page for MUME to improve clarity and navigability.

Documentation:

  • Rewrite the Abbreviations page description to clearly state its scope across mobs, chat, gameplay, items, locations, and lore.
  • Reorganize abbreviations into categorized sections with tables and lists for better readability and lookup.

Updated the description for the Abbreviations page and restructured the content to improve clarity and organization.
@sourcery-ai

sourcery-ai Bot commented May 24, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Restructures the Abbreviations page into organized sections with headings and tables, updates the page description, and standardizes formatting for all abbreviation entries across mobs/NPCs, chat, gameplay, items, locations, and lore.

Flow diagram for restructured Abbreviations documentation page

flowchart TD
  AbbrevPage[Abbreviations.md]
  AbbrevPage --> Desc[Frontmatter description]
  AbbrevPage --> Sections

  Sections --> Mobs[Mobs_And_NPCs]
  Sections --> Chat[Chat_Table]
  Sections --> Gameplay[Gameplay_Table]
  Sections --> Items[Items_Table]
  Sections --> Locations[Locations_Table]
  Sections --> Lore[Lore_List]

  Chat --> ChatRows[Standardized_rows]
  Gameplay --> GameplayRows[Standardized_rows]
  Items --> ItemsRows[Standardized_rows]
  Locations --> LocationRows[Standardized_rows]

  Lore --> LoreEntries[Bullet_entries]

  Desc --- UpdatedDesc[Updated to comprehensive guide wording]
Loading

File-Level Changes

Change Details Files
Restructure abbreviations content into categorized sections with improved formatting.
  • Replaces raw, inline abbreviation text with Markdown headings for each category (Mobs & NPCs, Chat, Gameplay, Items, Locations, Lore).
  • Converts most abbreviation lists into Markdown tables for better readability and consistent two-column layout (abbreviation vs meaning).
  • Uses bullet lists where tables are less appropriate (e.g., Mobs & NPCs and Lore) while keeping consistent bolding and punctuation for abbreviations.
  • Adds horizontal rules between major sections to visually separate categories.
docs/pages/Abbreviations.md
Standardize and clarify abbreviation entries.
  • Normalizes punctuation and spacing around abbreviations (e.g., using colons, spaces, and bold formatting consistently).
  • Groups related abbreviations together and merges redundant or variant entries (e.g., exp / xp, whobbit / wobbit, pk / pkill).
  • Clarifies or slightly rephrases certain definitions to be more readable while preserving original meaning (e.g., expanding MU description).
docs/pages/Abbreviations.md
Update page metadata to better describe the content.
  • Replaces the old, example-like description with a concise summary describing the page as a comprehensive guide to abbreviations used in MUME, covering multiple categories.
docs/pages/Abbreviations.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 2 issues, and left some high level feedback:

  • Consider making the formatting consistent across sections (e.g., using tables for Mobs & NPCs and Lore as well, or consistently using lists) so the page reads uniformly and is easier to scan.
  • Some table entries combine multiple abbreviations into one row (e.g., exp / xp, pk / pkill, whobbit / wobbit); if these are referenced individually elsewhere, it may be clearer to split them into separate rows to make lookup and linking more precise.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider making the formatting consistent across sections (e.g., using tables for Mobs & NPCs and Lore as well, or consistently using lists) so the page reads uniformly and is easier to scan.
- Some table entries combine multiple abbreviations into one row (e.g., `exp / xp`, `pk / pkill`, `whobbit / wobbit`); if these are referenced individually elsewhere, it may be clearer to split them into separate rows to make lookup and linking more precise.

## Individual Comments

### Comment 1
<location path="docs/pages/Abbreviations.md" line_range="146" />
<code_context>
+| **V** | Vala |
+| **Va** | Vala (Architect) |
+| **VL** | virtual |
+| **Vm** | Vala (Mudller) |
+| **V+** | Vala or higher |
+| **whobbit / wobbit** | hobbit |
</code_context>
<issue_to_address>
**issue (typo):** Typo in "Mudller"; consider correcting to "Muddler".

Given the other roles use standard English terms (Builder, Cartographer, Shaper, Wright), this appears to be an unintended misspelling rather than a new coined role name.

```suggestion
| **Vm** | Vala (Muddler) |
```
</issue_to_address>

### Comment 2
<location path="docs/pages/Abbreviations.md" line_range="191" />
<code_context>
+| **gbs** | great black scimitar |
+| **gilded** | gilded rounded shield |
+| **gleaming** | gleaming belt/broadsword |
+| **glowsword**| Artifact glowing sword (Sting etc..) |
+| **grey** | fine grey cloak |
+| **hbm** | huge, black mace |
</code_context>
<issue_to_address>
**issue (typo):** Fix double period in "etc..".

`etc..` has an extra period. Please change to `etc.)` or `etc.` depending on how you want to handle the closing parenthesis.

```suggestion
| **glowsword**| Artifact glowing sword (Sting etc.) |
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

| **V** | Vala |
| **Va** | Vala (Architect) |
| **VL** | virtual |
| **Vm** | Vala (Mudller) |

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.

issue (typo): Typo in "Mudller"; consider correcting to "Muddler".

Given the other roles use standard English terms (Builder, Cartographer, Shaper, Wright), this appears to be an unintended misspelling rather than a new coined role name.

Suggested change
| **Vm** | Vala (Mudller) |
| **Vm** | Vala (Muddler) |

Comment thread docs/pages/Abbreviations.md Outdated
| **gbs** | great black scimitar |
| **gilded** | gilded rounded shield |
| **gleaming** | gleaming belt/broadsword |
| **glowsword**| Artifact glowing sword (Sting etc..) |

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.

issue (typo): Fix double period in "etc..".

etc.. has an extra period. Please change to etc.) or etc. depending on how you want to handle the closing parenthesis.

Suggested change
| **glowsword**| Artifact glowing sword (Sting etc..) |
| **glowsword**| Artifact glowing sword (Sting etc.) |

@nschimme nschimme merged commit 9fbb209 into main May 24, 2026
2 checks passed
@nschimme nschimme deleted the nschimme-patch-1 branch May 24, 2026 15:49
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