docs: cleanup docs

Author: tazlin

CONTRIBUTING.md

@@ -23,8 +23,8 @@
 
 ### First time setup
 
-- Install uv, as described [here](https://github.com/astral-sh/uv/#installation).
-- `uv python install 3.10 3.11 3.12 3.13`
+- Install uv, as described [in their documentation](https://github.com/astral-sh/uv/#installation).
+- `uv python install 3.12 3.13`
 - `uv self update`
 - `uv sync --all-groups`
 - The `.venv/` directory will now be created with all project, development and documentation dependencies installed.
@@ -34,21 +34,18 @@
 
 - [**tox**](https://tox.wiki/)
     - Creates virtual environments for CI or local pytest runs.
-        - Note that the CI does not current execute calls to the production API by default.
+        - Note that the CI does not currently execute calls to the production API by default.
     - Run `tox list` or see `tox.ini` for more info
 - [**pre-commit**](https://pre-commit.com/)
     - Creates virtual environments for formatting and linting tools
     - Run `pre-commit run --all-files` or see `.pre-commit-config.yaml` for more info.
 
 > Note: Many of the tools below are run by `pre-commit` automatically, but can also be run manually if desired.
 
-- [**black**](https://github.com/psf/black)
-    - Whitespace formatter/code style formatter
-    - Run with `black .`
 - [**ruff**](https://github.com/astral-sh/ruff)
     - Linting rules from a wide variety of selectable rule sets
     - See `pyproject.toml` for the rules used.
-    - See all rules (but not necessarily used in the project) availible in rust [here](https://beta.ruff.rs/docs/rules/).
+    - See all rules (but not necessarily used in the project) [available in ruff here](https://beta.ruff.rs/docs/rules/).
     - Run with `ruff check .`
         - Note: When using autofixing (`ruff check . --fix`), changes may be made that require running black, which can then result in needing to run `ruff check . --fix` again.
         - Consider running `black . && ruff check . --fix && black . && ruff check . --fix` to avoid this.

README.md

@@ -1,23 +1,25 @@
-
 [![Tests](https://github.com/Haidra-Org/horde-sdk/actions/workflows/maintests.yml/badge.svg)](https://github.com/Haidra-Org/horde-sdk/actions/workflows/maintests.yml)
 [![Documentation Status](https://readthedocs.org/projects/horde-sdk/badge/?version=latest)](https://horde-sdk.readthedocs.io/en/latest/?badge=latest)
 [![Unstable Tests](https://github.com/Haidra-Org/horde-sdk/actions/workflows/prtests.yml/badge.svg)](https://github.com/Haidra-Org/horde-sdk/actions/workflows/prtests.yml)
+
 # horde_sdk
 
 ## Note
+
 horde_sdk is in **beta**. Everything is subject to change. Please feel free to report bugs or make suggestions on our [github issue page](https://https//github.com/Haidra-Org/horde-sdk)
 
 ## About
+
 This library simplifies interfacing with any API created by [Haidra](https://github.com/Haidra-Org) - the community organization
 behind the free projects such as AI-Horde ([homepage](https://aihorde.net/), [github](https://github.com/db0/AI-Horde)).
 The goal is to minimize the amount of time it takes to develop applications in python that use our free, volunteer driven, services which include:
 
-- Stable Diffusion Image Generation (driven by [ComfyUI](https://github.com/comfyanonymous/ComfyUI))
-- Image captioning
-- Image rating (currently ratings are for [diffusiondb](https://poloclub.github.io/diffusiondb/), others coming in the future)
+- Image Generation (driven by [ComfyUI](https://github.com/comfyanonymous/ComfyUI))
 - Text Generation using LLMs (driven by [KoboldAI](https://github.com/KoboldAI/KoboldAI-Client))
+- Image captioning
 
 From anything to requesting your own images, or rolling your own [worker](https://github.com/Haidra-Org/AI-Horde-Worker) software, this package may suit your needs.
 
 ## Documentation
-See the complete documentation at https://horde-sdk.readthedocs.io/en/latest/.
+
+See the complete documentation at <https://horde-sdk.readthedocs.io/en/latest/>.

docs/concepts/package_structure.md

@@ -150,6 +150,6 @@ By convention, the following files within an api support package should always c
 - `worker/generations.py`
     - Contains the concrete implementations of `HordeSingleGeneration` for each supported generation type.
     - These classes should generally be limited in terms of their own logic and when appropriate, delegate to the `HordeSingleGeneration` class's methods or implementations.
-- `worker/jobs_base.py`
+- `worker/job_base.py`
     - Contains the base class for all job types, `HordeWorkerJob`
         - `HordeWorkerJob` wraps `HordeSingleGeneration`

docs/index.md

@@ -11,10 +11,9 @@ This library simplifies interfacing with any API created by [Haidra](https://git
 behind the free projects such as AI-Horde ([homepage](https://aihorde.net/), [github](https://github.com/db0/AI-Horde)).
 The goal is to minimize the amount of time it takes to develop applications in python that use our free, volunteer driven, services which include:
 
-- Stable Diffusion Image Generation (driven by [ComfyUI](https://github.com/comfyanonymous/ComfyUI))
-- Image captioning
-- Image rating (currently ratings are for [diffusiondb](https://poloclub.github.io/diffusiondb/), others coming in the future)
+- Image Generation (driven by [ComfyUI](https://github.com/comfyanonymous/ComfyUI))
 - Text Generation using LLMs (driven by [KoboldAI](https://github.com/KoboldAI/KoboldAI-Client))
+- Image captioning
 
 From anything to requesting your own images, or rolling your own [worker](https://github.com/Haidra-Org/AI-Horde-Worker) software, this package may suit your needs.
 

docs/worker/generation_states_flow.md

@@ -2,7 +2,7 @@
 
 ## Typical States Flow
 
-This is visual depiction of the `base_generate_progress_transitions` map found in `horde_sdk/ai_horde_worker/consts.py`.
+This is visual depiction of the `base_generate_progress_transitions` map found in `horde_sdk/worker/consts.py`.
 
 You should also see the [worker loop](../haidra-assets/docs/worker_loop.md) and [job lifecycle explanation](../haidra-assets/docs/workers.md) for additional details.
 

docs/worker/generations.md

@@ -334,7 +334,7 @@ This guide should help you get started with the basic usage and required method
 
 ### Typical States Flow
 
-This is visual depiction of the `base_generate_progress_transitions` map found in `horde_sdk/ai_horde_worker/consts.py`.
+This is visual depiction of the `base_generate_progress_transitions` map found in `horde_sdk/worker/consts.py`.
 
 You should also see the [worker loop](../haidra-assets/docs/worker_loop.md) and [job lifecycle explanation](../haidra-assets/docs/workers.md) for additional details.