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

[V3 Docs] User guides #1734

Open
laggron42 opened this issue May 28, 2018 · 4 comments
Open

[V3 Docs] User guides #1734

laggron42 opened this issue May 28, 2018 · 4 comments
Labels
Category: Docs Status: In Progress
Projects

Comments

@laggron42
Copy link
Contributor

@laggron42 laggron42 commented May 28, 2018

The Red ReadTheDocs page currently has installation informations and API/coding guides. I think it would be good to also include some user guides, like "getting started" or detailed cog guides, as an alternative to the help command.

I can write these docs, I just need to know what you think about it and what would be the format. I already wrote detailed docs for my repo's cogs and I'm planning to do it the same way for core cogs.

Please take a look at the cog guides section of my ReadTheDocs page and see if it the format is ok for core cogs.

@mikeshardmind
Copy link
Contributor

@mikeshardmind mikeshardmind commented May 28, 2018

I feel like most of the commands in the bot do not need this level of explanation. However, I do think there are certain features in the bot which could be better documented. I think this is overall a good idea, but leave off the installation section since it should be covered by a page explaining how to load cogs, and I think it may make sense to only build this level of detailed documentation for cogs and commands which are not expected to be receiving modifications for a while to prevent it from becoming an extra step all the time (Not to never do it, but to wait on these until closer to release) (for instance, commands in the general cog are unlikely to change much currently, but things like mod and permissions are still getting improvements right now as needed)

@laggron42
Copy link
Contributor Author

@laggron42 laggron42 commented May 28, 2018

I can remove the installation section and just write a getting started guide, like on V2

@palmtree5 palmtree5 added the V3 label May 28, 2018
@Tobotimus Tobotimus added Category: Docs Status: In Progress labels Jun 3, 2018
@laggron42 laggron42 mentioned this issue Jun 4, 2018
3 tasks
@Tobotimus Tobotimus removed the V3 label Jun 29, 2019
@laundmo
Copy link

@laundmo laundmo commented May 15, 2020

as someone looking into using red it would be nice to have at least a copy paste of the help messsage somewhere. almost every bot has a command list, and i think the standard cogs for this should too.

i dont want to have to install it just to figure out the exact commands it has. this wouldnt be a problem with a hosted public bot, but since this is selfhosted i would have to install just to test. i need to know if its worth it before that.

@jack1142 jack1142 added this to To do in User guides Sep 20, 2020
@bobloy bobloy mentioned this issue Oct 19, 2020
3 tasks
@bobloy bobloy mentioned this issue Oct 22, 2020
3 tasks
@bobloy bobloy mentioned this issue Nov 5, 2020
3 tasks
@bobloy bobloy mentioned this issue Nov 12, 2020
3 tasks
@bobloy bobloy mentioned this issue Nov 12, 2020
3 tasks
@bobloy bobloy mentioned this issue Mar 3, 2021
4 tasks
@palmtree5
Copy link
Member

@palmtree5 palmtree5 commented Mar 13, 2021

Here's the current status of this issue:

Cog Done In Progress Not Started
Admin x
Alias x
Audio x
Bank x
Cleanup x
CogManagerUI x
Core x
CustomCommands x
Dev x
Downloader x
Economy x
Filter x
General x
Image x
Mod x
ModLog x
Mutes x
Permissions x
Reports x
Streams x
Trivia x
Warnings x

Technically the permissions cog has its cog reference that goes over how the permissions work but it is not a command reference

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Docs Status: In Progress
Projects
User guides
  
To do
Development

No branches or pull requests

5 participants