Skip to content

Commit ce6e0f7

Browse files
committed
docs(tree): Fix link + misc. formatting improvements
1 parent 4fb43f2 commit ce6e0f7

File tree

1 file changed

+4
-3
lines changed
  • packages/dds/tree/src/simple-tree/api

1 file changed

+4
-3
lines changed

packages/dds/tree/src/simple-tree/api/tree.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -257,11 +257,12 @@ export interface TreeBranch extends IDisposable {
257257
/**
258258
* An editable view of a (version control style) branch of a shared tree based on some schema.
259259
*
260-
* This schema--known as the view schema--may or may not align the stored schema of the document.
260+
* @remarks
261+
* This schema (known as the view schema) may or may not align with the stored schema of the document.
261262
* Information about discrepancies between the two schemas is available via {@link TreeView.compatibility | compatibility}.
262263
*
263-
* Application authors are encouraged to read [schema-evolution.md](../../docs/user-facing/schema-evolution.md) and
264-
* choose a schema compatibility policy that aligns with their application's needs.
264+
* Application authors are encouraged to read {@link https://github.com/microsoft/FluidFramework/blob/main/packages/dds/tree/docs/user-facing/schema-evolution.md | schema-evolution.md}
265+
* and choose a schema compatibility policy that aligns with their application's needs.
265266
*
266267
* @privateRemarks
267268
* From an API design perspective, `upgradeSchema` could be merged into `viewWith` and/or `viewWith` could return errors explicitly on incompatible documents.

0 commit comments

Comments
 (0)