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 "Where to go from here?" to cog creation guide #6134

Open
Jackenmen opened this issue May 7, 2023 · 2 comments
Open

Add "Where to go from here?" to cog creation guide #6134

Jackenmen opened this issue May 7, 2023 · 2 comments
Labels
Category: Docs - For Developers This is related to developer (cog creator) documentation. Status: Accepted We want this Type: Enhancement Something meant to enhance existing Red features.

Comments

@Jackenmen
Copy link
Member

What component of Red (cog, command, API) would you like to see improvements on?

"Creating cogs for Red V3" document

Describe the enhancement you're suggesting.

The current document doesn't really go beyond creating a simple "hello world" cog. We mention the Red V2 migration guide in the "Additional resources" section but that probably isn't useful to the vast majority of people reading this document these days.

I think we should replace that with a "Where to go from here?" section (could also just keep the more boring "Additional resources" name :P) describing how you can take the next step by mentioning discord.py documentation, a few core APIs (especially the documents about Config, Data Manager, Utility Functions, commands package, and the bot class), and mentioning that more documentation can be found in the sidebar. Maybe some general pointers on how to navigate d.py's and Red's documentation could be helpful as well, unsure.
This section should probably go above the "Publish your cog" and "Becoming an Approved Cog Creator" sections.

Anything else?

No response

@Jackenmen Jackenmen added Type: Enhancement Something meant to enhance existing Red features. Status: Accepted We want this Category: Docs - For Developers This is related to developer (cog creator) documentation. labels May 7, 2023
@KyrVorga
Copy link

KyrVorga commented May 7, 2023

Perhaps an advanced walkthrough of creating a complex cog, I've found that learning by doing is the best for a lot of people, myself included. It would only need to cover core concepts.

@Jackenmen
Copy link
Member Author

Perhaps an advanced walkthrough of creating a complex cog

Yeah, this could be worth doing though it might also be worth having a bit more detailed tutorials like the one we have in Config's documentation for other bot components. This also makes me think that a lot of people learn by example and so we should consider mentioning that you could learn by looking at the source code of other people's approved cogs. This does come with a caveat that not all such cogs have the best code quality but approved cogs do have to follow common cog practices so that's good.

@Jackenmen Jackenmen modified the milestones: 3.4.x, 3.5.2 May 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Docs - For Developers This is related to developer (cog creator) documentation. Status: Accepted We want this Type: Enhancement Something meant to enhance existing Red features.
Projects
None yet
Development

No branches or pull requests

2 participants