docs

tripolskypetr · tripolskypetr · commit 370be0c41994 · 2025-09-29T12:33:29.000+05:00
diff --git a/docs/interfaces/IAgentSchemaCallbacks.md b/docs/interfaces/IAgentSchemaCallbacks.md
diff --git a/docs/interfaces/IOutlineFormat.md b/docs/interfaces/IOutlineFormat.md
diff --git a/docs/types/ComputeName.md b/docs/types/ComputeName.md
@@ -9,4 +9,5 @@ group: docs
 type ComputeName = string;
 ```
 
-
+Type alias for the compute name, represented as a string.
+Used to identify and reference specific compute instances.
diff --git a/docs/types/DisposeFn$1.md b/docs/types/DisposeFn$1.md
@@ -9,4 +9,5 @@ group: docs
 type DisposeFn$1 = () => void;
 ```
 
-
+Function type for cleanup operations.
+Called when resources need to be disposed in global config context.
diff --git a/docs/types/DisposeFn.md b/docs/types/DisposeFn.md
@@ -9,4 +9,5 @@ group: docs
 type DisposeFn = () => void;
 ```
 
-
+Function type for cleanup operations.
+Called when resources need to be disposed.
diff --git a/docs/types/EntityId.md b/docs/types/EntityId.md
@@ -9,4 +9,5 @@ group: docs
 type EntityId = string | number;
 ```
 
-
+Represents an identifier for an entity, which can be either a string or a number.
+Used across persistence classes to uniquely identify stored entities such as agents, states, or memory records.
diff --git a/docs/types/ExecutionId.md b/docs/types/ExecutionId.md
@@ -9,4 +9,5 @@ group: docs
 type ExecutionId = string;
 ```
 
-
+A unique identifier for an execution instance.
+Used to track and manage execution flows within the swarm.
diff --git a/docs/types/IComputeData.md b/docs/types/IComputeData.md
@@ -9,4 +9,5 @@ group: docs
 type IComputeData = any;
 ```
 
-
+Generic type for compute data, allowing flexibility in data structure.
+Can be any type to support diverse compute operations.
diff --git a/docs/types/PipelineName.md b/docs/types/PipelineName.md
@@ -9,4 +9,5 @@ group: docs
 type PipelineName = string;
 ```
 
-
+Type alias for the pipeline name, represented as a string.
+Used to identify and reference specific pipeline instances.
diff --git a/docs/types/ScopeOptions.md b/docs/types/ScopeOptions.md
@@ -9,4 +9,5 @@ group: docs
 type ScopeOptions = Partial<ISchemaContext["registry"]>;
 ```
 
-
+Optional overrides for schema services used within the schema context.
+Allows partial customization of the schema registry.
diff --git a/docs/types/TAgentSchema.md b/docs/types/TAgentSchema.md
@@ -11,4 +11,6 @@ type TAgentSchema = {
 } & Partial<IAgentSchema>;
 ```
 
-
+Type representing a partial agent schema with required agentName.
+Used for overriding existing agent configurations with selective updates.
+Combines required agent name with optional agent properties.
diff --git a/docs/types/TChatInstanceCtor.md b/docs/types/TChatInstanceCtor.md
@@ -9,4 +9,4 @@ group: docs
 type TChatInstanceCtor = new <Payload extends unknown = any>(clientId: SessionId, swarmName: SwarmName, onDispose: DisposeFn, callbacks: IChatInstanceCallbacks, payload: Payload) => IChatInstance;
 ```
 
-
+Constructor type for creating chat instances with dispose callback.
diff --git a/docs/types/TCompletionSchema.md b/docs/types/TCompletionSchema.md
@@ -11,4 +11,6 @@ type TCompletionSchema = {
 } & Partial<ICompletionSchema>;
 ```
 
-
+Type representing a partial completion schema with required completionName.
+Used for overriding existing completion configurations with selective updates.
+Combines required completion name with optional completion properties.
diff --git a/docs/types/TEmbeddingSchema.md b/docs/types/TEmbeddingSchema.md
@@ -11,4 +11,6 @@ type TEmbeddingSchema = {
 } & Partial<IEmbeddingSchema>;
 ```
 
-
+Type representing a partial embedding schema with required embeddingName.
+Used for overriding existing embedding configurations with selective updates.
+Combines required embedding name with optional embedding properties.
diff --git a/docs/types/TOperatorInstanceCtor.md b/docs/types/TOperatorInstanceCtor.md
@@ -9,4 +9,5 @@ group: docs
 type TOperatorInstanceCtor = new (clientId: string, agentName: AgentName, callbacks: Partial<IOperatorInstanceCallbacks>) => IOperatorInstance;
 ```
 
-
+Constructor type for OperatorInstance.
+Defines the signature for creating operator instances with client ID, agent name, and callbacks.
diff --git a/docs/types/TPolicySchema.md b/docs/types/TPolicySchema.md
@@ -11,4 +11,6 @@ type TPolicySchema = {
 } & Partial<IPolicySchema>;
 ```
 
-
+Type representing a partial policy schema with required policyName.
+Used for overriding existing policy configurations with selective updates.
+Combines required policy name with optional policy properties.
diff --git a/docs/types/TSchemaContextService.md b/docs/types/TSchemaContextService.md
@@ -9,4 +9,5 @@ group: docs
 type TSchemaContextService = InstanceType<typeof SchemaContextService>;
 ```
 
-
+Type alias for instances of the SchemaContextService class.
+Used for dependency injection and service management.
diff --git a/docs/types/TSharedState.md b/docs/types/TSharedState.md
@@ -11,4 +11,5 @@ type TSharedState = {
 };
 ```
 
-
+Type definition for a shared state object, mapping IState keys to unknown values.
+Used for type-safe shared state access across multiple clients.
diff --git a/docs/types/TState.md b/docs/types/TState.md
@@ -11,4 +11,5 @@ type TState = {
 };
 ```
 
-
+Type definition for a state object, mapping IState keys to unknown values.
+Used for type-safe state access within client context.
diff --git a/docs/types/TStorage.md b/docs/types/TStorage.md
@@ -11,4 +11,5 @@ type TStorage = {
 };
 ```
 
-
+Type definition for a storage object, mapping IStorage keys to unknown values.
+Used for type-safe storage access within client context.
diff --git a/docs/types/WikiName.md b/docs/types/WikiName.md
@@ -9,4 +9,5 @@ group: docs
 type WikiName = string;
 ```
 
-
+Type alias for wiki name identifier.
+Used to identify and reference specific wiki instances.
