Skip to content

Commit

Permalink
doc: add note about the id compressor in quick start doc (#22426)
Browse files Browse the repository at this point in the history
adds note about shared tree's requirement of id compressor
  • Loading branch information
jenn-le authored Sep 6, 2024
1 parent 5bac231 commit 1cc829d
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/content/docs/start/tree-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ This guide will walk you through the basics of creating, configuring, and intera
A `SharedTree` can be created by defining a `ContainerSchema` with an initial object of type `SharedTree` and using this schema to create and load your container.
This example creates a container using an Azure specific client.

**note**: `enableRuntimeIdCompressor` must be enabled in the [container runtime options](../api/v2/container-runtime/icontainerruntimeoptions-interface.md) in order to use `SharedTree`

See more info on creating and loading containers [here](../build/containers.md#creating-a-container).

```typescript
Expand Down

0 comments on commit 1cc829d

Please sign in to comment.