-
Notifications
You must be signed in to change notification settings - Fork 0
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
Add documentation for the discord bot #123
Comments
We have an all-in-one google doc guide that intricately describes the discord setup. I think this is the place to add our bot documentation, at least for now, though the document itself is part of our value proposition and in an effort to appropriate its value, it is restricted-access and google's sharing is pretty inadequate given the number of individuals who may soon need to be added to/removed from the document. I think the optimal solution would be to embed the google doc on a restricted access page, or transfer it to a markdown page, but before even that it needs some further organization. I need to give this more thought but my ideas stray towards private wiki territory which is a step towards the original vision I had... In any case these are high effort alternatives and like I said, extending the google doc for now is a safe step. |
Google Docs sound good for now. Something to note though is that the discord bot currently needs to be configured using json, which is code heavy. Ideally, there's some sort of UI for editing the config, but it's for internal use and high effort to create. |
This is also something we should consider with #125 |
The Google docs version of the discord bot docs do exist now, but are outdated. |
We should add a link to the discord bot docs to the repo and make it a rule to update the docs whenever changes are made. |
Is your feature request related to a problem? Please describe.
There currently is no documentation available for branch leaders on how to use the discord bot.
Describe the solution you'd like
Add a markdown document to this Github repo that we can link to branch leaders.
Describe alternatives you've considered
Add documentation using the bot.
Add documentation using Github wikis.
Add documentation using the DevLUp website.
The text was updated successfully, but these errors were encountered: