Docs.

Author: TommyBrosman

packages/dds/shared-object-base/src/sharedObjectKernel.ts

@@ -294,7 +294,9 @@ export interface KernelArgs {
 	 */
 	readonly lastSequenceNumber: () => number;
 	/**
-	 * The minVersionForCollab specified when instantiating the ContainerRuntime.
+	 * The minVersionForCollab specified when instantiating the ContainerRuntime. Passed to the SharedKernelFactory so that a
+	 * compatible set of feature flags and formats can be enabled in the SharedObject implementation.
+	 * See {@link @fluidframework/container-runtime#LoadContainerRuntimeParams} for more details on this property.
 	 */
 	readonly minVersionForCollab: MinimumVersionForCollab | undefined;
 }

packages/runtime/container-runtime/src/channelCollection.ts

@@ -132,7 +132,8 @@ export interface IFluidParentContextPrivate extends Omit<IFluidParentContext, "i
 	readonly isReadOnly: () => boolean;
 
 	/**
-	 * Gets the minVersionForCollab passed into the ContainerRuntime.
+	 * Gets the minVersionForCollab passed into the ContainerRuntime. Consumed by {@link FluidDataStoreContext}.
+	 * See {@link @fluidframework/container-runtime#LoadContainerRuntimeParams} for more details.
 	 */
 	getMinVersionForCollab(): MinimumVersionForCollab;
 }

packages/runtime/container-runtime/src/dataStoreContext.ts

@@ -1216,6 +1216,9 @@ export abstract class FluidDataStoreContext
 		return this.parentContext.uploadBlob(blob, signal);
 	}
 
+	/**
+	 * {@inheritdoc IFluidDataStoreContext.getMinVersionForCollab}
+	 */
 	public getMinVersionForCollab(): MinimumVersionForCollab {
 		return this.parentContext.getMinVersionForCollab();
 	}

packages/runtime/datastore-definitions/src/dataStoreRuntime.ts

@@ -197,7 +197,10 @@ export interface IFluidDataStoreRuntimeInternalConfig {
 	readonly submitMessagesWithoutEncodingHandles?: boolean;
 
 	/**
-	 * The minVersionForCollab used when instantiating the ContainerRuntime. DDSes may read this value to determine which feature flags should be enabled.
+	 * The minVersionForCollab used when instantiating the ContainerRuntime. DDSes may read this value to determine which feature flags
+	 * should be enabled. This property is consumed by SharedObjectFactory (which are implementations of
+	 * {@link @fluidframework/datastore-definitions#IChannelFactory}).
+	 * See {@link @fluidframework/container-runtime#LoadContainerRuntimeParams} for more details on `minVersionForCollab`.
 	 */
 	readonly minVersionForCollab?: MinimumVersionForCollab | undefined;
 }

packages/runtime/datastore/api-report/datastore.legacy.beta.api.md

@@ -68,7 +68,6 @@ export class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataStoreRunt
     // (undocumented)
     get logger(): ITelemetryLoggerExt;
     makeVisibleAndAttachGraph(): void;
-    // (undocumented)
     readonly minVersionForCollab: MinimumVersionForCollab | undefined;
     notifyReadOnlyState(readonly: boolean): void;
     // (undocumented)

packages/runtime/datastore/src/dataStoreRuntime.ts

@@ -294,7 +294,7 @@ export class FluidDataStoreRuntime
 	private readonly submitMessagesWithoutEncodingHandles: boolean;
 
 	/**
-	 * @see IFluidDataStoreRuntimeInternalConfig.minVersionForCollab
+	 * See `IFluidDataStoreRuntimeInternalConfig.minVersionForCollab`.
 	 */
 	public readonly minVersionForCollab: MinimumVersionForCollab | undefined;
 

packages/runtime/runtime-definitions/src/dataStoreContext.ts

@@ -740,7 +740,8 @@ export interface IFluidDataStoreContext extends IFluidParentContext {
 	): ReturnType<Exclude<T["createDataStore"], undefined>>;
 
 	/**
-	 * Gets the minVersionForCollab passed into the ContainerRuntime.
+	 * Gets the minVersionForCollab passed into the ContainerRuntime. Consumed by {@link @fluidframework/datastore#FluidDataStoreRuntime}.
+	 * See {@link @fluidframework/container-runtime#LoadContainerRuntimeParams} for more details.
 	 */
 	getMinVersionForCollab?(): MinimumVersionForCollab;
 }

packages/runtime/test-runtime-utils/api-report/test-runtime-utils.legacy.beta.api.md

@@ -350,7 +350,6 @@ export class MockFluidDataStoreContext implements IFluidDataStoreContext {
     isLocalDataStore: boolean;
     // (undocumented)
     makeLocallyVisible(): void;
-    // (undocumented)
     minVersionForCollab: MinimumVersionForCollab;
     // (undocumented)
     off(event: string | symbol, listener: (...args: any[]) => void): this;

packages/runtime/test-runtime-utils/src/mocksDataStoreContext.ts

@@ -77,6 +77,9 @@ export class MockFluidDataStoreContext implements IFluidDataStoreContext {
 	public createProps?: any;
 	public scope: FluidObject = undefined as any;
 
+	/**
+	 * Allows tests to set the value of minVersionForCollab.
+	 */
 	public minVersionForCollab: MinimumVersionForCollab = defaultMinVersionForCollab;
 
 	constructor(