Skip to content

Create usage documentation #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 15, 2017
Merged

Conversation

buchholz-sean
Copy link
Contributor

Documentation for Max Bot usage once installed. Includes a link in README.md to the usage doc.

Documentation for Max Bot usage once installed. Includes a link in README.md to the usage doc.
Removes all roles from the user. _Tabula rasa_, baby.


## Administrative commands
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that the broadcast functionality hasn't been added to a release yet. Everything from line 58 down can be scrapped or edited as necessary.

Copy link
Contributor

@MROwens MROwens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks good to me!

@ghost
Copy link

ghost commented Nov 14, 2017

would look into getting some documentation for nodemailer seeing as we are using there services to setup the email verification, possible option could be:

nodemailer

npm install nodemailer --save
Max-Bot uses nodemailer to send verification emails to students that are attempting to verify their Full Sail University email address.

@buchholz-sean
Copy link
Contributor Author

Great call, @JoeGreen2. Will update.

Added information about Nodemailer module. Also replaced a reference to `.env` file with `max.config.js` which is current correct env config file.
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@buchholz-sean buchholz-sean merged commit 2e859eb into dev Nov 15, 2017
@reactivepixel reactivepixel deleted the feature-verify-documentation branch August 21, 2019 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants