Clean up docs with exercise utils

Author: woojiahao

docs/architecture/deployment-pipeline.md

@@ -23,3 +23,7 @@ The versioning is done as follows: `<major>.<minor>.<patch>` where
 The app automatically checks for the latest version published and warns users if their local version is out of date if the `<major>` or `<minor>` versions are wrong.
 
 If you do not have permissions to push a new tag, contact <[email protected]> for assistance.
+
+{: .note }
+
+For more information for packaging for Linux, refer to [this Notion page](https://woojiahao.notion.site/linux-packaging-226f881eda0580d68bc8dc6f8e1d5d0d?source=copy_link).

docs/contributing/exercise.md

@@ -45,12 +45,17 @@ The `download.py` contains the instructions to setup the local repository.
 
 For more information about how Git-Mastery downloads exercises, refer to the [Download Workflow](/developers/docs/architecture/download-workflow)
 
-The default download script comes with a helper function to `run_command` to run local command, and a command to attach a tag as the "start tag". This is only useful if you want to iterate through the user's commits in your verification script. Otherwise, this can be removed.
+{: .note }
+
+> `exercises` comes with a set of utility functions in the `exercise_utils` module that are made available during the download flow. They provide simple wrappers around common functionality such as `exercise_utils.cli.run_command` to invoke any command and `exercise_utils.file.create_or_update_file` to create or update a given file.
+> 
+> For the full list of utility functions, refer [here](/developers/docs/tooling/exercise-utils).
 
 These are some references for download setups for other exercises:
 
 - [ignoring-somethings](https://raw.githubusercontent.com/git-mastery/exercises/refs/heads/main/ignoring_somethings/download.py)
 - [branch-bender](https://raw.githubusercontent.com/git-mastery/exercises/refs/heads/main/branch_bender/download.py)
+- [amateur-detective]
 
 ### Download conventions
 

docs/contributing/hands-on.md

@@ -45,12 +45,19 @@ Hands-on downloads are all single-file stored in `hands_on/`. The `<hands on nam
 
 For more information about how Git-Mastery downloads hands-on, refer to the [Download Workflow](/developers/docs/architecture/download-workflow)
 
-The default download script comes with a helper function to `run_command` to run local command.
+{: .note }
+
+> `exercises` comes with a set of utility functions in the `exercise_utils` module that are made available during the download flow. They provide simple wrappers around common functionality such as `exercise_utils.cli.run_command` to invoke any command and `exercise_utils.file.create_or_update_file` to create or update a given file.
+> 
+> For the full list of utility functions, refer [here](/developers/docs/tooling/exercise-utils).
+
+).
 
 These are some references for download setups for other exercises:
 
 - [init-repo](https://raw.githubusercontent.com/git-mastery/exercises/refs/heads/main/hands_on/init_repo.py)
 - [add-files](https://raw.githubusercontent.com/git-mastery/exercises/refs/heads/main/hands_on/add_files.py)
+- [stage-modified](https://raw.githubusercontent.com/git-mastery/exercises/refs/heads/main/hands_on/stage_modified.py)
 
 ### Download conventions
 

docs/tooling/exercise-utils.md

@@ -0,0 +1,28 @@
+---
+title: Exercise utilities
+nav_order: 1
+parent: Tooling
+---
+
+These are all contained within the [`exercises/exercise_utils` module](https://github.com/git-mastery/exercises/tree/main/exercise_utils).
+
+These are loaded when downloading an exercise, which means that the `app` has access to these functions.
+
+## Available utility functions
+
+There are functions broadly for the following categories:
+
+- `exercise_utils.cli`: Generic CLI calls
+- `exercise_utils.file`: File creation/appending
+- `exercise_utils.git`: Common Git operations like commit, initializing a repository, and adding files
+- `exercise_utils.gitmastery`: Git-Mastery specific functions like creating the start tag
+
+## Contributing utility functions
+
+These should cover around 80% of all use cases, but if there isn't an existing utility function for your use case, `exercise_utils.cli.run_command` is available to execute any other CLI calls.
+
+If you believe that more utility functions should be supported, feel free to open a PR adding one.
+
+{: .note }
+
+If you add a new file, for example `exercise_utils/general.py`, please update `app` to include the file in the `EXERICSE_UTILS_FILES` constant [here](https://github.com/git-mastery/app/blob/6786aa998e9c8f7ca63c77534bfaf5b7514a89c2/app/utils/gitmastery.py#L212).

docs/tooling/index.md

@@ -0,0 +1,6 @@
+---
+title: Tooling
+nav_order: 4
+---
+
+Git-Mastery maintains various tools to support development.

docs/libraries/index.md docs/tooling/libraries.mddocs/libraries/index.md renamed to docs/tooling/libraries.md

@@ -1,8 +1,11 @@
 ---
-title: Libraries
-nav_order: 4
+title: Published libraries
+nav_order: 2
+parent: Tooling
 ---
 
+## Published Python packages
+
 Git-Mastery publishes and maintains several public packages:
 
 - [`repo-smith`](https://github.com/git-mastery/repo-smith)