Smokedetector: Add documentation for new chat system

Created on 1 Jan 2018 · 8Comments · Source: Charcoal-SE/SmokeDetector

Scroll down for Hacktoberfest summary and guidance.

It would be nice to get some documentation for the NG chat system put on the wiki.

Kindly, @quartata provided an excellent overview in the original PR, which would form good documentation with little tweaking.

Documentation should cover:

[x] Adding new commands
[x] Posting to chat manually
[x] Adding/removing rooms and room roles
[x] Configuring the rooms for development

documentation hacktoberfest feature request up-for-grabs

Source

angussidney

👍1

All 8 comments

https://github.com/Charcoal-SE/SmokeDetector/wiki/Creating-new-commands is the page that I have created for the documentation of adding new commands.

paper1111 on 19 Feb 2018

contrib-guidance

Summary

Difficulty:
2/5 stars
Scope:
Narrow scope
Issue Owner: angussidney

At the end of 2017 we redeveloped the entire system which SmokeDetector uses to communicate with chat. Some of this new system has already been documented, however our rooms.yml configuration file remains undocumented. The rooms.yml file is responsible for determining which rooms our bot runs in, with what levels of functionality, and who has the ability to interact with it.

Guidance

First of all, we recommend that you familiarise yourself with how SmokeDetector interacts with various chatrooms - the chatrooms wiki page might be helpful. You can also drop into Charcoal HQ (see the 'how to get help' section below) and ask some of our regulars how it all works.

You'll need to create a new wiki page and document the rooms.yml file. The file itself is somewhat self-explanatory, so you shouldn't have too much trouble documenting it. The original PR description and the code for communicating with chat should also contain some useful information.

Make sure you:

document the structure and what each keyword/section means
describe the process of adding a new room
describe how a custom room configuration can be used for development - see this code

A note on Hacktoberfest & PRs

Since this is a documentation contribution, you won't actually have to submit a PR. However, if you're participating in Hacktoberfest, we would still love for your contribution to count towards your PR count for a free t-shirt. Once you've finished this issue, simply make a superficial PR to fix a typo in our README or do something similar, and we'd be happy to merge it.

How to get help

For additional support in completing this issue, either:

comment on this thread
if you have a Stack Overflow account, drop into our chatroom (you'll need 20 reputation - if you don't have that, let the issue owner know your username or ID here so they can arrange for access)
email the issue owner at [email protected]

angussidney on 8 Sep 2018

Hello @angussidney , I will love to work on this issue for Hacktoberfest