Skip to content

docs: rewrite README for players and administrators - #101

Merged
TWME-TW merged 1 commit into
TWME-TW:mainfrom
twme-ai:docs/user-focused-readme
Aug 19, 2026
Merged

docs: rewrite README for players and administrators#101
TWME-TW merged 1 commit into
TWME-TW:mainfrom
twme-ai:docs/user-focused-readme

Conversation

@twme-ai

@twme-ai twme-ai commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • rewrite the README around user goals instead of release history
  • add a dedicated Player Guide covering setup, controls, modes, and commands
  • add a dedicated Administrator Guide covering installation, permissions, configuration, localization, integrations, troubleshooting, and compatibility
  • retain the existing mode screenshots while moving development details to the end

Validation

  • checked all documented commands and behavior against the implementation
  • checked every declared permission and top-level config section for README coverage
  • rendered the document with GitHub GFM (7 tables rendered)
  • verified all Markdown links
  • ran Markdown lint with line-length disabled for tables and long URLs
  • ran spelling, ASCII, and git diff --check checks

@twme-ai
twme-ai force-pushed the docs/user-focused-readme branch from 9ea9383 to b42d864 Compare August 19, 2026 04:44
@TWME-TW
TWME-TW merged commit 8c3216c into TWME-TW:main Aug 19, 2026
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.

2 participants