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

Add documentation for the discord bot #123

Open
Exanite opened this issue Jan 1, 2023 · 5 comments
Open

Add documentation for the discord bot #123

Exanite opened this issue Jan 1, 2023 · 5 comments
Assignees
Labels
Discord Bot Relates to the DevLUp Discord Bot Enhancement New feature or request

Comments

@Exanite
Copy link
Member

Exanite commented Jan 1, 2023

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.

@Exanite Exanite added Enhancement New feature or request Discord Bot Relates to the DevLUp Discord Bot labels Jan 1, 2023
@ModeratelyGreek
Copy link

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.

@ModeratelyGreek ModeratelyGreek self-assigned this Jan 8, 2023
@Exanite
Copy link
Member Author

Exanite commented Jan 8, 2023

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.
There's a Google Docs extension that you can use, but Markdown is a bit more natural for code.

Ideally, there's some sort of UI for editing the config, but it's for internal use and high effort to create.

@Exanite
Copy link
Member Author

Exanite commented Aug 14, 2023

This is also something we should consider with #125

@Exanite
Copy link
Member Author

Exanite commented Aug 26, 2023

The Google docs version of the discord bot docs do exist now, but are outdated.

@Exanite
Copy link
Member Author

Exanite commented Sep 14, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discord Bot Relates to the DevLUp Discord Bot Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants