mt-mods / beerchat

beerchat mod for minetest
GNU Lesser General Public License v3.0
9 stars 7 forks source link

Documentation for callback API and extensions #17

Open S-S-X opened 4 years ago

S-S-X commented 4 years ago

Improve documentation for beerchat.

S-S-X commented 2 years ago

Also doc/manual.md content does not really make sense anymore, could possibly just remove that file completely and rewrite API docs in some doc/API.md and then add basic capability/command/configuration manual directly to README.md.

Most of it is anyway documented well enough with /help and only some special stuff really needs documentation in repo: channel usage with #, whispering with $ and private messages with @.

Extensions could have separate file for documentation? Currently there's:

I think most other stuff is documented well enough with /help whateverbeerchatcommand

S-S-X commented 1 month ago

Additionally missing docs for /cc channel update mechanism. Like a lot of other stuff this is in /help but not in docs.