Red-DiscordBot icon indicating copy to clipboard operation
Red-DiscordBot copied to clipboard

Update readme with information about Discord

Open blam1992 opened this issue 2 years ago • 4 comments

Description of the changes

Adds a short description of Discord and how to download it within the overview section.

Closes #6183

Have the changes in this PR been tested?

Yes

blam1992 avatar Jun 12 '23 20:06 blam1992

Any ideas as to why the 2 checks got cancelled?

blam1992 avatar Jun 12 '23 21:06 blam1992

Just reminder that this PR closes issue #6183

NoPlagiarism avatar Jun 12 '23 21:06 NoPlagiarism

Is the download URL necessary if we are already linking it to the Discord main website? it feels like something akin to the following is enough.

"Red is a interactable bot for Discord using its API through the Discord.py library."

If the goal is to assist newcomers understand what Red is for, this should be sufficient, as this is directing you to the service main page where they themselves educate new users as to what they are this would also nail the Discord API docs reference and Discord.Py reference.

Feels like speaking at a high level and providing the relevant link for each of the 3 primary dependencies, is sufficient rather than going into too much detail that users can get themselves through previously referenced links.

Edit: Because going into too much default here would be akin to discussing the Python dependency or async or Postgres/JSON.

Drapersniper avatar Jun 12 '23 22:06 Drapersniper

I agree, the download link might not be necessary if we are linking users to the main website. I think it's a good idea to keep the short description of Discord, as it can be helpful for people who are new to the software or who want a quick refresher.

blam1992 avatar Jun 13 '23 00:06 blam1992