Merge pull request #690 from tisnik/lcore-632-update-package-descriptions

LCORE-632: update package descriptions

Author: tisnik

src/README.md

@@ -15,6 +15,9 @@ Constants used in business logic.
 ## [lightspeed_stack.py](lightspeed_stack.py)
 Entry point to the Lightspeed Core Stack REST API service.
 
+## [llama_stack_configuration.py](llama_stack_configuration.py)
+Llama Stack configuration handling.
+
 ## [log.py](log.py)
 Log utilities.
 

src/app/endpoints/README.md

@@ -12,6 +12,9 @@ Handler for REST API call to retrieve service configuration.
 ## [conversations.py](conversations.py)
 Handler for REST API calls to manage conversation history.
 
+## [conversations_v2.py](conversations_v2.py)
+Handler for REST API calls to manage conversation history.
+
 ## [feedback.py](feedback.py)
 Handler for REST API endpoint for user feedback.
 
@@ -27,12 +30,21 @@ Handler for REST API call to provide metrics.
 ## [models.py](models.py)
 Handler for REST API call to list available models.
 
+## [providers.py](providers.py)
+Handler for REST API calls to list and retrieve available providers.
+
 ## [query.py](query.py)
 Handler for REST API call to provide answer to query.
 
 ## [root.py](root.py)
 Handler for the / endpoint.
 
+## [shields.py](shields.py)
+Handler for REST API call to list available shields.
+
 ## [streaming_query.py](streaming_query.py)
 Handler for REST API call to provide answer to streaming query.
 
+## [tools.py](tools.py)
+Handler for REST API call to list available tools from MCP servers.
+

src/cache/README.md

@@ -0,0 +1,26 @@
+# List of source files stored in `src/cache` directory
+
+## [__init__.py](__init__.py)
+Various cache implementations.
+
+## [cache.py](cache.py)
+Abstract class that is parent for all cache implementations.
+
+## [cache_error.py](cache_error.py)
+Any exception that can occur during cache operations.
+
+## [cache_factory.py](cache_factory.py)
+Cache factory class.
+
+## [in_memory_cache.py](in_memory_cache.py)
+In-memory cache implementation.
+
+## [noop_cache.py](noop_cache.py)
+No-operation cache implementation.
+
+## [postgres_cache.py](postgres_cache.py)
+PostgreSQL cache implementation.
+
+## [sqlite_cache.py](sqlite_cache.py)
+Cache that uses SQLite to store cached values.
+

src/metrics/README.md

@@ -1,7 +1,7 @@
 # List of source files stored in `src/metrics` directory
 
 ## [__init__.py](__init__.py)
-Metrics module for Lightspeed Stack.
+Metrics module for Lightspeed Core Stack.
 
 ## [utils.py](utils.py)
 Utility functions for metrics handling.

src/models/README.md

@@ -3,6 +3,9 @@
 ## [__init__.py](__init__.py)
 Pydantic models.
 
+## [cache_entry.py](cache_entry.py)
+Model for conversation history cache entry.
+
 ## [config.py](config.py)
 Model with service configuration.
 

src/quota/README.md

@@ -0,0 +1,8 @@
+# List of source files stored in `src/quota` directory
+
+## [__init__.py](__init__.py)
+Quota management.
+
+## [sql.py](sql.py)
+SQL commands used by quota management package.
+

src/runners/README.md

@@ -3,6 +3,9 @@
 ## [__init__.py](__init__.py)
 Runners.
 
+## [quota_scheduler.py](quota_scheduler.py)
+User and cluster quota scheduler runner.
+
 ## [uvicorn.py](uvicorn.py)
 Uvicorn runner.
 

src/utils/README.md

@@ -1,14 +1,17 @@
 # List of source files stored in `src/utils` directory
 
 ## [__init__.py](__init__.py)
-Utils.
+Utility classes and functions for the Lightspeed Stack core service.
 
 ## [checks.py](checks.py)
 Checks that are performed to configuration options.
 
 ## [common.py](common.py)
 Common utilities for the project.
 
+## [connection_decorator.py](connection_decorator.py)
+Decorator that makes sure the object is 'connected' according to it's connected predicate.
+
 ## [endpoints.py](endpoints.py)
 Utility functions for endpoint handlers.
 
@@ -21,6 +24,12 @@ MCP headers handling.
 ## [suid.py](suid.py)
 Session ID utility functions.
 
+## [token_counter.py](token_counter.py)
+Helper classes to count tokens sent and received by the LLM.
+
+## [tool_formatter.py](tool_formatter.py)
+Utility functions for formatting and parsing MCP tool descriptions.
+
 ## [transcripts.py](transcripts.py)
 Transcript handling.
 

src/utils/connection_decorator.py

@@ -1,10 +1,10 @@
-"""Decocator that makes sure the object is 'connected' according to it's connected predicate."""
+"""Decorator that makes sure the object is 'connected' according to it's connected predicate."""
 
 from typing import Any, Callable
 
 
 def connection(f: Callable) -> Callable:
-    """Decocator that makes sure the object is 'connected' according to it's connected predicate.
+    """Make decorator that makes sure the object is connected according to it's connected predicate.
 
     Example:
     ```python