Skip to content
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

Document bot/server setup, commands in GitHub Wiki #4

Open
skyegallup opened this issue Oct 31, 2020 · 3 comments
Open

Document bot/server setup, commands in GitHub Wiki #4

skyegallup opened this issue Oct 31, 2020 · 3 comments
Assignees
Milestone

Comments

@skyegallup
Copy link
Collaborator

skyegallup commented Oct 31, 2020

BrickHack and other hackathon servers will likely be setup by people without intimate knowledge of this bot's inner workings. Proper documentation is needed to explain how to correctly setup these servers so that the bot may function effectively.

We should also take time to add internal (read: in the code) documentation, especially for things like the per-command methods.

@skyegallup
Copy link
Collaborator Author

Needs to be fast-tracked for two reasons:
1.) Chris needs to setup a staging server for bot testing, which requires a setup guide.
2.) We might be working on BH guild setup soon w/ Mark, which would be easier with documentation

@skyegallup skyegallup self-assigned this Nov 22, 2020
@skyegallup
Copy link
Collaborator Author

#17 (fix build commands) and #14 (mentor-only commands) need to be merged before this can be merged.

@skyegallup
Copy link
Collaborator Author

External documentation done in issue-4 and wiki. Still need to work on internal documentation a bit more, however.

@skyegallup skyegallup added this to the BrickHack 7 milestone Dec 13, 2020
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

No branches or pull requests

1 participant