Forum teuk.org

πŸ“š *Accio Documentum!* β€” The Mediabot Wiki Opens Its Spellbook

in Mediabot Β· started by TeuK Β· 1w ago

TeuK Β· 1w ago

After a long series of refactors, migrations, live tests, and hardening passes, Mediabot v3 now has something it badly deserved: proper command documentation.

Not just a few examples. Not just a quick list of public commands.
A real wiki update, organized by command type and user level.

β€œA spell is only useful if the wizard knows when he is allowed to cast it.” πŸͺ„


πŸ§™ Why this matters

Mediabot has grown a lot.

It now includes classic IRC features, quote management, user/admin commands, Partyline support, database-backed features, Claude/AI integration, karma, reminders, polls, live tests, schema drift checks, and more.

That is powerful β€” but without documentation, it becomes easy to get lost.

So this update adds a clearer command reference to the GitHub wiki, with commands grouped by access level and usage context.

The goal is simple:

  • help regular users discover safe public commands;
  • help authenticated users understand what they can do;
  • help channel admins and bot owners find the right command quickly;
  • make future command additions easier to document.

🏰 The new wiki pages

Four Markdown pages were prepared for the wiki.

Public-commands.md

This page documents the public commands that can be used from IRC channels.

It focuses on commands like:

help
version
date
seen
q
karma
poll
vote
remind
ai
youtube / yt
weather

The idea is to give users a clear view of what can be used directly in a channel.


Private-and-admin-commands.md

This page documents private commands, authentication commands, user management, channel management, and administrative features.

It covers command families such as:

login
logout
whoami
userinfo
users
chaninfo
chanset
addcmd
delcmd
showcmd
restart
die
status

This is the page for people who actually operate the bot.


Command-level-index.md

This is the big one.

It groups commands by required level:

public
private
authorized
operator+
channel admin
admin
master
owner

This makes it much easier to answer:

β€œWhat can this user level actually do?”

Instead of hunting through code or scattered help output, the wiki now gives a structured access-level index.


Command-documentation-audit.md

This page is more technical.

It is meant to track documentation coverage and help spot commands that may exist in code but still need better explanation.

It is useful for maintainers and future cleanup work.


🧾 Wiki integration

The GitHub wiki is its own Git repository:

git clone git@github.com:teuk/mediabot_v3.wiki.git

The generated files are mapped like this:

Public-commands.generated.md             -> Public-commands.md
Private-and-admin-commands.generated.md  -> Private-and-admin-commands.md
mediabot_command_level_index.md          -> Command-level-index.md
mediabot_wiki_command_audit.md           -> Command-documentation-audit.md

The wiki home page also gets a new section:

## Command documentation

- [Public commands](Public-commands)
- [Private and admin commands](Private-and-admin-commands)
- [Command level index](Command-level-index)
- [Command documentation audit](Command-documentation-audit)

So the documentation becomes visible from the wiki front page instead of being hidden in random files.


πŸ§ͺ Why this fits the recent work

This documentation work comes after a big stabilization phase:

  • fresh install validation;
  • schema migration documentation;
  • tools/check_schema_drift.pl;
  • live test fixtures based on the real schema;
  • Partyline restart tests;
  • Claude/AI hardening;
  • full static and live test runs going green.

So the wiki update is not isolated. It follows the same idea:

Make Mediabot easier to install, easier to test, easier to operate, and easier to understand.

The code is stronger when the documentation follows the same discipline.


πŸͺ„ The Harry Potter bit

This one feels like a proper library spell.

Not a battle spell.
Not a fireball.
More like Hermione opening the exact page you needed before you even knew what to search for.

Accio Documentum!

The commands are now summoned, sorted, and placed into the wiki.

No more wandering through the Forbidden Forest of undocumented IRC commands.


βœ… Result

Mediabot v3 now has a much clearer public command reference, private/admin command reference, and level-based command index.

That means:

less guesswork
less tribal knowledge
less β€œwhat level do I need for this?”
more usable documentation
more maintainable command growth

Mischief managed β€” but this time, with a table of contents. πŸ“šπŸͺ„

You must be logged in to reply.