docs: Documentation pass

Author: grypez

packages/kernel-language-model-service/src/kernel-service.ts

@@ -11,8 +11,8 @@ import type {
 export const LANGUAGE_MODEL_SERVICE_NAME = 'languageModelService';
 
 /**
- * Wraps `chat` and optional `sample` functions into a flat, stateless kernel service object
- * suitable for passing to `Kernel.make()` or `Kernel.registerKernelServiceObject()`.
+ * Wraps `chat` and optional `sample` functions into a flat, stateless kernel service object.
+ * Use the returned `{ name, service }` with `kernel.registerKernelServiceObject(name, service)`.
  *
  * Return values are plain hardened data — no exos — so they are safely serializable
  * across the kernel marshal boundary.

packages/kernel-language-model-service/src/test-utils/mock-fetch.ts

@@ -1,3 +1,11 @@
+/**
+ * Returns a fetch implementation that responds to Open /v1 chat completion requests
+ * with a sequence of non-streaming JSON responses (one content string per request).
+ *
+ * @param responses - Content strings to return, in order, for each request.
+ * @param model - Model name to include in the response (default `'test-model'`).
+ * @returns A fetch function suitable for use as an endowment.
+ */
 export const makeMockOpenV1Fetch = (
   responses: string[],
   model = 'test-model',

packages/kernel-language-model-service/src/test-utils/mock-sample.ts

@@ -1,5 +1,11 @@
 import type { SampleParams, SampleResult } from '../types.ts';
 
+/**
+ * Returns a sample function that returns a sequence of result texts (one per call).
+ *
+ * @param responses - Text strings to return, in order, for each call.
+ * @returns A function matching the sample service signature.
+ */
 export const makeMockSample = (
   responses: string[],
 ): ((params: SampleParams) => Promise<SampleResult>) => {

packages/kernel-language-model-service/src/types.ts

@@ -103,7 +103,7 @@ export type ChatResult = {
 };
 
 /**
- * Minimal service interface required by `makeChatCompletionClient`.
+ * Minimal service interface required by `makeChatClient`.
  */
 export type ChatService = {
   chat: (params: ChatParams) => Promise<ChatResult>;

packages/kernel-test-local/src/constants.ts

@@ -10,10 +10,8 @@ export const TEST_MODELS = ['llama3.1:latest', 'gpt-oss:20b'];
 export const OLLAMA_API_BASE = 'http://localhost:11434';
 export const OLLAMA_TAGS_ENDPOINT = `${OLLAMA_API_BASE}/api/tags`;
 
-// extract ignored logger tags from environment variable
-
 /**
- * The tags to ignore for the local tests.
+ * Logger tags to ignore, parsed from the LOGGER_IGNORE environment variable.
  */
 export const IGNORE_TAGS =
   // eslint-disable-next-line n/no-process-env

packages/kernel-test-local/src/utils.ts

@@ -23,7 +23,7 @@ export const filterTransports = (
 /**
  * Generate a random letter.
  *
- * @returns a random letter.
+ * @returns A random letter.
  */
 export function randomLetter(): string {
   return String.fromCharCode(Math.floor(Math.random() * 26) + 97);

packages/kernel-test-local/src/vats/lms-chat-vat.ts

@@ -6,7 +6,7 @@ import type { ChatService } from '@ocap/kernel-language-model-service';
 
 /**
  * A vat that uses a kernel language model service to perform a chat completion
- * and logs the response. Used by lms-kernel.test.ts to verify the full
+ * and logs the response. Used by lms-chat.test.ts and lms-chat.e2e.test.ts to verify the full
  * kernel → LMS service → Ollama round-trip.
  *
  * @param vatPowers - Vat powers, expected to include a logger.