Check that all commands and functions are documented in the wiki, and have .help messages.
Description
Details
- Security
- None
Status | Assigned | Task | ||
---|---|---|---|---|
Open | None | T150 Write some coding conventions and guidelines on liniting | ||
Open | None | T152 Release Version 10 (last version not a 'bundle') | ||
Resolved | Sario528 | T159 Fix doc errors | ||
Open | RhinosF1 | T160 Work out a way to keep documentation up to date | ||
Resolved | Sario528 | T156 Documentation check |
Event Timeline
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.
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.
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