Revise Abbreviations page content and description#27
Conversation
Updated the description for the Abbreviations page and restructured the content to improve clarity and organization.
Reviewer's GuideRestructures 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 pageflowchart 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]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
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>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) | |
There was a problem hiding this comment.
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.
| | **Vm** | Vala (Mudller) | | |
| | **Vm** | Vala (Muddler) | |
| | **gbs** | great black scimitar | | ||
| | **gilded** | gilded rounded shield | | ||
| | **gleaming** | gleaming belt/broadsword | | ||
| | **glowsword**| Artifact glowing sword (Sting etc..) | |
There was a problem hiding this comment.
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.
| | **glowsword**| Artifact glowing sword (Sting etc..) | | |
| | **glowsword**| Artifact glowing sword (Sting etc.) | |
Updated the description for the Abbreviations page and restructured the content to improve clarity and organization.
Description
Related Issue
Checklist
::: details Spoiler) as defined in the Contributing Guide.docker compose up --build wiki(ornpm run docs:build) and verified changes locally.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: