docs: add docs to CB

Pretty much every class and method should have documentation now.

ref: N25B-295

src/control_backend/core/config.py

@@ -3,6 +3,16 @@ from pydantic_settings import BaseSettings, SettingsConfigDict
 
 
 class ZMQSettings(BaseModel):
+    """
+    Configuration for ZeroMQ (ZMQ) addresses used for inter-process communication.
+
+    :ivar internal_pub_address: Address for the internal PUB socket.
+    :ivar internal_sub_address: Address for the internal SUB socket.
+    :ivar ri_command_address: Address for sending commands to the Robot Interface.
+    :ivar ri_communication_address: Address for receiving communication from the Robot Interface.
+    :ivar vad_agent_address: Address for the Voice Activity Detection (VAD) agent.
+    """
+
     internal_pub_address: str = "tcp://localhost:5560"
     internal_sub_address: str = "tcp://localhost:5561"
     ri_command_address: str = "tcp://localhost:0000"
@@ -11,6 +21,21 @@ class ZMQSettings(BaseModel):
 
 
 class AgentSettings(BaseModel):
+    """
+    Names of the various agents in the system. These names are used for routing messages.
+
+    :ivar bdi_core_name: Name of the BDI Core Agent.
+    :ivar bdi_belief_collector_name: Name of the Belief Collector Agent.
+    :ivar bdi_program_manager_name: Name of the BDI Program Manager Agent.
+    :ivar text_belief_extractor_name: Name of the Text Belief Extractor Agent.
+    :ivar vad_name: Name of the Voice Activity Detection (VAD) Agent.
+    :ivar llm_name: Name of the Large Language Model (LLM) Agent.
+    :ivar test_name: Name of the Test Agent.
+    :ivar transcription_name: Name of the Transcription Agent.
+    :ivar ri_communication_name: Name of the RI Communication Agent.
+    :ivar robot_speech_name: Name of the Robot Speech Agent.
+    """
+
     # agent names
     bdi_core_name: str = "bdi_core_agent"
     bdi_belief_collector_name: str = "belief_collector_agent"
@@ -25,6 +50,21 @@ class AgentSettings(BaseModel):
 
 
 class BehaviourSettings(BaseModel):
+    """
+    Configuration for agent behaviors and parameters.
+
+    :ivar sleep_s: Default sleep time in seconds for loops.
+    :ivar comm_setup_max_retries: Maximum number of retries for setting up communication.
+    :ivar socket_poller_timeout_ms: Timeout in milliseconds for socket polling.
+    :ivar vad_prob_threshold: Probability threshold for Voice Activity Detection.
+    :ivar vad_initial_since_speech: Initial value for 'since speech' counter in VAD.
+    :ivar vad_non_speech_patience_chunks: Number of non-speech chunks to wait before speech ended.
+    :ivar transcription_max_concurrent_tasks: Maximum number of concurrent transcription tasks.
+    :ivar transcription_words_per_minute: Estimated words per minute for transcription timing.
+    :ivar transcription_words_per_token: Estimated words per token for transcription timing.
+    :ivar transcription_token_buffer: Buffer for transcription tokens.
+    """
+
     sleep_s: float = 1.0
     comm_setup_max_retries: int = 5
     socket_poller_timeout_ms: int = 100
@@ -42,24 +82,60 @@ class BehaviourSettings(BaseModel):
 
 
 class LLMSettings(BaseModel):
-    local_llm_url: str = "http://localhost:1234/v1/chat/completions"
-    local_llm_model: str = "openai/gpt-oss-20b"
-    request_timeout_s: int = 120
+    """
+    Configuration for the Large Language Model (LLM).
+
+    :ivar local_llm_url: URL for the local LLM API.
+    :ivar local_llm_model: Name of the local LLM model to use.
+    :ivar request_timeout_s: Timeout in seconds for LLM requests.
+    """
+
+    local_llm_url: str = "http://localhost:11434/v1/chat/completions"
+    local_llm_model: str = "gpt-oss"
+    request_timeout_s: int = 10
 
 
 class VADSettings(BaseModel):
+    """
+    Configuration for Voice Activity Detection (VAD) model.
+
+    :ivar repo_or_dir: Repository or directory for the VAD model.
+    :ivar model_name: Name of the VAD model.
+    :ivar sample_rate_hz: Sample rate in Hz for the VAD model.
+    """
+
     repo_or_dir: str = "snakers4/silero-vad"
     model_name: str = "silero_vad"
     sample_rate_hz: int = 16000
 
 
 class SpeechModelSettings(BaseModel):
+    """
+    Configuration for speech recognition models.
+
+    :ivar mlx_model_name: Model name for MLX-based speech recognition.
+    :ivar openai_model_name: Model name for OpenAI-based speech recognition.
+    """
+
     # model identifiers for speech recognition
     mlx_model_name: str = "mlx-community/whisper-small.en-mlx"
     openai_model_name: str = "small.en"
 
 
 class Settings(BaseSettings):
+    """
+    Global application settings.
+
+    :ivar app_title: Title of the application.
+    :ivar ui_url: URL of the frontend UI.
+    :ivar zmq_settings: ZMQ configuration.
+    :ivar agent_settings: Agent name configuration.
+    :ivar behaviour_settings: Behavior configuration.
+    :ivar vad_settings: VAD model configuration.
+    :ivar speech_model_settings: Speech model configuration.
+    :ivar llm_settings: LLM configuration.
+    """
+
     app_title: str = "PepperPlus"
 
     ui_url: str = "http://localhost:5173"