docs: update contributing to include nox (#653)

Signed-off-by: arielle <me@arielle.codes>
Co-authored-by: Joshie <74162303+CoderJoshDK@users.noreply.github.com>

Author: onerandomusername

CONTRIBUTING.md

@@ -82,8 +82,7 @@ git clone https://github.com/onerandomusername/monty-python
 cd monty-python
 ```
 
-Next, create a file named `.env` within the cloned repository. This will be used
-later regardless of how you run Monty.
+Next, create a file named `.env` within the cloned repository.
 
 A minimum viable contents (if using Docker) are as follows:
 
@@ -94,8 +93,8 @@ BOT_TOKEN=...
 # to change the default prefix from `-`
 PREFIX=...
 
-# optional, used to increase GitHub ratelimits from
-# 60 to 5000/h and enable the graphql API
+# optional, but necessary for anything using GitHub,
+# required to enable the GitHub related code
 GITHUB_TOKEN=...
 ```
 
@@ -111,8 +110,12 @@ uv run prek install
 If you don't already have uv installed, check the
 [uv documentation](https://docs.astral.sh/uv/), or use a tool like pipx or uvx.
 
-Make sure you install prek, as it will lint every commit before its created,
-limiting the amount of fixes needing to be made in the review process.
+Make sure you run `prek install`, as it will integrate with git and lint every
+commit before committing, limiting the amount of fixes needing to be made in the
+review process.
+
+Some fixes aren't automatic or done with prek, so take a look at
+[Running CI locally](#running-ci-locally)
 
 ### Create a Discord Bot
 
@@ -172,9 +175,42 @@ docker compose up monty
 Monty should now be running! There's now a few other configuration things to do
 to finish initialising the database. See the bot only commands.
 
-## Building the documentation
+## Running CI locally
+
+As a public bot, Monty Python has continuous integration through GitHub actions
+and other developer tools to ensure that Monty is held to strict quality
+standards (as time progresses)!
+
+To run the CI equivalent locally, we use nox as our runner.
+
+```sh
+uv run nox
+```
+
+With no arguments, this command will run all of the sessions and fixes that we
+run in CI.
+
+If any changes are made, the results should be commited along with the rest of
+your code.
+
+### Commands and Autodoc
+
+To document the procedures and methods on Monty, there is a custom script which
+serves to update two files listing the prefix and application commands that are
+available on Monty. These files are still in beta, and should not be relied at
+this moment for anything other than contributing documentation.
 
-TLDR
+Running the autodoc session should automatically update these files, if there
+were any changes.
+
+```sh
+uv run nox -s autodoc`
+```
+
+### Building the documentation
+
+To preview the documentation with an automatic reloading server, use the
+following command:
 
 ```sh
 uv run nox -s docs
@@ -188,3 +224,10 @@ uv run mkdocs serve
 
 The dev server runs on http://127.0.0.1:8000 by default. Use `mkdocs build` to
 produce the static site into `site/`.
+
+If you modified any documentation pages, including the CONTRIBUTING.md document
+or the README.md, make sure you run mdformat.
+
+```sh
+uv run nox -s mdformat
+```

docs/contributing/developer-commands.md

@@ -41,7 +41,8 @@ extensions or modules for development.
     - Unload currently loaded extensions given their fully qualified or
         unqualified names.
 - `ext autoreload`
-    - Autoreload of modified extensions.
+    - Autoreload of modified extensions. This watches for file edits, and will
+        reload modified extensions automatically.
 
 > [!TIP]
 > The library that is required for the autoreload command is only installed for
@@ -58,10 +59,14 @@ only. This command runs within the event loop, and **within the bot context**.
 > to your bot and computer.
 
 This command is named `ieval`, short for internal evaluation. It processes with
-the same syntax rules as the `eval` command, which uses the snekbox backend, but
-is instead run within the bot. This is a developer-only command, as you can
-easily print the bot token or do other nefarious things.
+the same parsing rules as the `eval` command, which uses the snekbox backend,
+but this command is run within the bot. This is a developer-only command, as you
+can easily print the bot token or do other nefarious things.
 
 ```py
 -ieval await ctx.send("this is from the bot context!")
 ```
+
+This command was recently rewritten, and has a few known bugs, see
+<https://github.com/onerandomusername/monty-python/issues/621> for more details.
+If you'd like to fix these, please do!

docs/future-plans.md

@@ -8,47 +8,50 @@ These are a list of future plans and integrations for Monty. If you want to help
 with one, please open an issue to flesh out the idea a bit more before
 contributing.
 
+There is also a list of future plans and integrations @
+<https://github.com/onerandomusername/monty-python/issues>
+
 ## Todo
 
 ### Core
 
-- Speed up boot time
-- Restructure deployments to be able to use RESUMING when deploying a new
+- [ ] Speed up boot time
+- [ ] Restructure deployments to be able to use RESUMING when deploying a new
     version of Monty (don't lose any events between deployments)
-- Use `monty.utils.responses` in more places.
-- Type safety
-- Enforce `DeleteButton` on *every. single. reply.*
+- [ ] Use `monty.utils.responses` in more places.
+- [ ] Type safety
+- [ ] Enforce `DeleteButton` on *every. single. reply.*
 
 ### Database management
 
-- Rewrite guild configuration to be eager upon guild join
-- Per-user configuration (see below)
+- [ ] Rewrite guild configuration to be eager upon guild join
+- [ ] Per-user configuration (see below)
 
 ### Dependencies
 
-- Drop some of the additional markdown parsers
+- [ ] Drop some of the additional markdown parsers
 
 ### GitHub Parsing
 
-- Migrate to Mistune v3
-- Rewrite GitHub processing to be more reconfigurable
-- Support components v2
-- Add image support to replies
-- Per user configuration of settings, see below
+- [ ] Migrate to Mistune v3
+- [ ] Rewrite GitHub processing to be more reconfigurable
+- [ ] Support components v2
+- [ ] Add image support to replies
+- [ ] Per user configuration of settings, see below
 
 ### User Support
 
-- Per-user configuration
-    - documentation objects
-    - github org
-    - github expand configuration
-    - discourse expand
-- Per-user Feature system for deployments
-- Admin support for user blacklist
+- [ ] Per-user configuration
+    - [ ] documentation objects
+    - [ ] github org
+    - [ ] github expand configuration
+    - [ ] discourse expand
+- [ ] Per-user Feature system for deployments
+- [ ] Admin support for user blacklist
 
 ## Completed
 
-- Rewrite the developer-side feature view command
-- Add contributing documentation
-- Migrate to uv
-- Add an autodoc of all app commands to the documentation website.
+- [x] Rewrite the developer-side feature view command
+- [x] Add contributing documentation
+- [x] Migrate to uv
+- [x] Add an autodoc of all app commands to the documentation website.

mkdocs.yaml

@@ -56,6 +56,8 @@ plugins:
 markdown_extensions:
 - admonition
 - pymdownx.details
+- pymdownx.tasklist:
+    custom_checkbox: true
 - pymdownx.superfences
 - markdown_gfm_admonition
 - pymdownx.highlight:

monty/exts/core/extensions.py

@@ -314,7 +314,11 @@ async def _autoreload_worker(self, channel: disnake.abc.Messageable) -> None:
         invoke_without_command=True,
     )
     async def autoreload(self, ctx: commands.Context) -> None:
-        """Autoreload of modified extensions."""
+        """
+        Autoreload of modified extensions.
+
+        This watches for file edits, and will reload modified extensions automatically.
+        """
         msg = "Autoreload is currently: "
         msg += "enabled" if self.bot._autoreload_task and not self.bot._autoreload_task.done() else "disabled"
         msg += "."