Page MenuHomePhabricator

Documentation check
Closed, ResolvedPublic

Description

Check that all commands and functions are documented in the wiki, and have .help messages.

Details

Security
None

Event Timeline

Sario528 triaged this task as Normal priority.Jan 23 2021, 7:15 PM
Sario528 created this task.

I reviewed the documentation for all MHBot specific commands, and found the following:

  • There is no public documentation for Sygnal.
  • Command documentation exists on bots.miraheze.wiki but not on bots.miraheze.org
  • The following commands are not listed on the Documentation page:
    • the check and reset cache commands for chanops, phab, and status
    • .rss
    • .stock
  • The the following commands did not have a help message, but did have a help example
    • .highpri
    • .task
    • .stock
    • .setlocation
  • The help message for .miraheze was sent via PM, despite not being particularly long.

Questions for bot Admins:

  • Should Sygnal documentation be public? And if not, should there be a "Contact MHBot Admins for more info" type message?
  • Should command documentation be available on the wiki?
  • I think we can document the commands, though I think @RhinosF1 has stuff planned for that module.
  • I certainly wouldn't be opposed to that.
In T156#2776, @Sario528 wrote:

I reviewed the documentation for all MHBot specific commands, and found the following:

  • There is no public documentation for Sygnal.

This should be a seperate task to make public as much of Sygnal as we can.

  • Command documentation exists on bots.miraheze.wiki but not on bots.miraheze.org

That's intended. .wiki should be canonical for user facing stuff. Sysadminy stuff on .org

  • The following commands are not listed on the Documentation page:
    • the check and reset cache commands for chanops, phab, and status

There gonna be gone by 10.0.0 so shrug

  • .rss

Already gone on dev

  • .stock

Should be added, fairly recent external package

  • The the following commands did not have a help message, but did have a help example
    • .highpri

Should be added if it wasn't picked up recently

  • .task

As above

  • .stock

#upstream

  • .setlocation

#upstream

  • The help message for .miraheze was sent via PM, despite not being particularly long.

Seperate bug, might be negated by the factoid work due soon

Questions for bot Admins:

  • Should Sygnal documentation be public? And if not, should there be a "Contact MHBot Admins for more info" type message?

As much as possible should be public

  • Should command documentation be available on the wiki?

Wiki is more for technical planning and stuff rather than user facing docs.

  • I think we can document the commands, though I think @RhinosF1 has stuff planned for that module.

Sygnal is on my radar. I want to rework the whole help stuff when self generating commands comes in.

  • I certainly wouldn't be opposed to that.

See clarifications made

.task and .highpri are already fixed on dev

.task and .highpri are already fixed on dev

Feel free to update website based on that then