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

Update readme with information about Discord #6186

Open
wants to merge 9 commits into
base: V3/develop
Choose a base branch
from

Conversation

blam1992
Copy link

@blam1992 blam1992 commented Jun 12, 2023

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

@github-actions github-actions bot added Category: Docs - Other This is related to documentation that doesn't have its dedicated label. Docs-only labels Jun 12, 2023
@blam1992
Copy link
Author

Any ideas as to why the 2 checks got cancelled?

@NoPlagiarism
Copy link

Just reminder that this PR closes issue #6183

@Flame442 Flame442 changed the title Pr/discordintro Update readme with information about Discord Jun 12, 2023
@Flame442 Flame442 added the Type: Enhancement Something meant to enhance existing Red features. label Jun 12, 2023
@Drapersniper
Copy link
Contributor

Drapersniper commented Jun 12, 2023

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.

@blam1992
Copy link
Author

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.

Comment on lines +68 to +69
communicate with their friends and communities. Discord utilizes servers that contain chat rooms and
voice channels that can be accessed through invite links.
Copy link
Member

Choose a reason for hiding this comment

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

I think that the second sentence here may be non-obvious, "servers" in the context that Discord uses it is IMO not an everyday use of the term. "spaces" is probably better. The meaning I would try to convey here is:

Discord allows any of its users to create spaces (servers) with text and video chat rooms (channels) for their friend groups or communities.

Part of this is already said in the first sentence so it would be good to not say the same thing twice too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Docs - Other This is related to documentation that doesn't have its dedicated label. Docs-only Type: Enhancement Something meant to enhance existing Red features.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Readme to include a section explaining what is Discord.
5 participants