search

danparizher / Pax-Academia

General purpose utility bot for the Homework Help Discord server
MIT License
13 stars 5 forks source link

Implement basic documentation for ease of use #166

Closed dddictionary closed 1 year ago

dddictionary commented 1 year ago

This PR updates implements simple documentation on how to contribute to this project.

The root README.md file gives steps to contribute, redirecting to another markdown file on getting the environment set up, and steps to run the bot itself.

The README.md file in the cogs folder just has small details about what each cog is/does.

The main concern now is the README.md in the cogs folder. I, to the best of my ability, tried to skim the files and write down what I understood they did. Mostly talked about the slash commands they implement as that seems the most straightforward way getting the point across. I left the cogs cogs that I didn't know about blank or not detailed.

I still want to implement the todo idea, where a contributor can read the file to see which aspects of the bot need to be worked on, but still drawing blanks as to how to implement that. So far, I just have (WIP) next to the cog that is still in progress.

Please feel free to change any vocabulary mistakes, terminology, etc.

danparizher commented 1 year ago

Do not merge yet—I would like documentation surrounding the new /detect-ai command as well from #161 cc: @dddictionary

dddictionary commented 1 year ago

New push includes:

  1. changes to the environment setup file.
    • Get rid of playwright command when downloading and setting up packages
    • New .env variables and their descriptions
  2. changes to cogs folder's readme
    • added description for detect-ai cog. Explained how it works and the restrictions on role and channel.