Update documentation for kvstore titles.

PiperOrigin-RevId: 580968592
Change-Id: Icdc507cf1061d325d6584697534b4df2937bbf59

README.md

@@ -16,7 +16,7 @@ storage and manipulation of large multi-dimensional arrays that:
 
 * Natively supports multiple storage systems, such as local and network
   filesystems, [Google Cloud Storage](https://cloud.google.com/storage),
-  HTTP servers, and in-memory storage.
+  Amazon S3-compatible object stores, HTTP servers, and in-memory storage.
 
 * Offers an asynchronous API to enable high-throughput access even to
   high-latency remote storage.

tensorstore/kvstore/file/schema.yml

@@ -1,5 +1,7 @@
 $schema: http://json-schema.org/draft-07/schema#
 $id: kvstore/file
+title: Read/write access to the local filesystem.
+description: JSON specification of the key-value store.
 allOf:
 - $ref: KvStore
 - type: object
@@ -12,16 +14,13 @@ allOf:
     file_io_concurrency:
       $ref: ContextResource
       description: |-
-        Specifies or references a previously defined
-        `Context.file_io_concurrency`.
+        Specifies or references a previously defined `Context.file_io_concurrency`.
     file_io_sync:
       $ref: ContextResource
       description: |-
-        Specifies or references a previously defined
-        `Context.file_io_sync`.
+        Specifies or references a previously defined `Context.file_io_sync`.
   required:
   - path
-title: JSON specification of file-backed key-value store.
 definitions:
   url:
     $id: KvStoreUrl/file

tensorstore/kvstore/gcs/schema.yml

@@ -1,5 +1,7 @@
 $schema: http://json-schema.org/draft-07/schema#
 $id: kvstore/gcs
+title: Read/write access to Google Cloud Storage (GCS).
+description: JSON specification of the key-value store.
 allOf:
 - $ref: KvStore
 - type: object

tensorstore/kvstore/grpc/schema.yml

@@ -1,5 +1,7 @@
 $schema: http://json-schema.org/draft-07/schema#
 $id: kvstore/grpc
+title: Read/write key-value store using the tensorstore-specific gRPC protocol.
+description: JSON specification of the key-value store.
 allOf:
 - $ref: KvStore
 - type: object

tensorstore/kvstore/http/schema.yml

@@ -1,5 +1,7 @@
 $schema: http://json-schema.org/draft-07/schema#
 $id: kvstore/http
+title: Read-only access to arbitrary HTTP servers.
+description: JSON specification of the key-value store.
 allOf:
 - $ref: KvStore
 - type: object

tensorstore/kvstore/memory/schema.yml

@@ -1,5 +1,7 @@
 $schema: http://json-schema.org/draft-07/schema#
 $id: kvstore/memory
+title: Read/write, non-persistent in-memory storage.
+description: JSON specification of the key-value store.
 allOf:
 - $ref: KvStore
 - type: object

tensorstore/kvstore/neuroglancer_uint64_sharded/schema.yml

@@ -1,5 +1,7 @@
 $schema: http://json-schema.org/draft-07/schema#
 $id: kvstore/neuroglancer_uint64_sharded
+title: Read/write adapter for the :ref:`Neuroglancer Precomputed<neuroglancer-precomputed-driver>` sharded format.
+description: JSON specification of the key-value store.
 allOf:
 - $ref: KvStore
 - type: object
@@ -15,7 +17,7 @@ allOf:
       $ref: kvstore/neuroglancer_uint64_sharded/ShardingSpec
     cache_pool:
       $ref: ContextResource
-      description: |-
+      description: |
         Specifies or references a previously defined `Context.cache_pool`.  It
         is normally more convenient to specify a default `~Context.cache_pool`
         in the `.context`.
@@ -26,20 +28,17 @@ allOf:
            `~Context.cache_pool.total_bytes_limit` value.  Otherwise, every read
            operation will require 2 additional reads, to read the shard index
            and the minishard index.
-           
       default: cache_pool
     data_copy_concurrency:
       $ref: ContextResource
       description: |-
-        Specifies or references a previously defined
-        `Context.data_copy_concurrency`.  It is normally more
-        convenient to specify a default `~Context.data_copy_concurrency` in
+        Specifies or references a previously defined `Context.data_copy_concurrency`.
+        It is normally more convenient to specify a default `~Context.data_copy_concurrency` in
         the `.context`.
       default: data_copy_concurrency
   required:
   - base
   - metadata
-title: JSON specification of neuroglancer_uint64_sharded key-value store.
 definitions:
   sharding-spec:
     $id: 'kvstore/neuroglancer_uint64_sharded/ShardingSpec'

tensorstore/kvstore/ocdbt/schema.yml

@@ -1,5 +1,7 @@
 $schema: http://json-schema.org/draft-07/schema#
 $id: kvstore/ocdbt
+title: Read/write adapter for the OCDBT format.
+description: JSON specification of the key-value store.
 allOf:
 - $ref: KvStore
 - type: object
@@ -79,20 +81,19 @@ allOf:
       $ref: ContextResource
       description: |-
         Specifies or references a previously defined `Context.cache_pool`.  It
-        is normally more convenient to specify a default `~Context.cache_pool`
+        is typically more convenient to specify a default `~Context.cache_pool`
         in the `.context`.
       default: cache_pool
     data_copy_concurrency:
       $ref: ContextResource
       description: |-
         Specifies or references a previously defined
-        `Context.data_copy_concurrency`.  It is normally more
+        `Context.data_copy_concurrency`.  It is typically more
         convenient to specify a default `~Context.data_copy_concurrency` in
         the `.context`.
       default: data_copy_concurrency
   required:
   - base
-title: JSON specification of OCDBT key-value store.
 definitions:
   zstd_compression:
     $id: kvstore/ocdbt/Compression/zstd

tensorstore/kvstore/s3/index.rst

@@ -3,7 +3,8 @@
 ``s3`` Key-Value Store driver
 ===============================
 
-The ``s3`` driver provides access to S3. Keys directly correspond to HTTP paths.
+The ``s3`` driver provides access to Amazon S3 and S3-compatible object stores.
+Keys directly correspond to paths within an S3 bucket.
 
 .. json:schema:: kvstore/s3
 

tensorstore/kvstore/s3/schema.yml

@@ -1,5 +1,7 @@
 $schema: http://json-schema.org/draft-07/schema#
 $id: kvstore/s3
+title: Read/write access to Amazon S3-compatible object stores.
+description: JSON specification of the key-value store.
 allOf:
 - $ref: KvStore
 - type: object

tensorstore/kvstore/zarr3_sharding_indexed/schema.yml

@@ -1,5 +1,7 @@
 $schema: http://json-schema.org/draft-07/schema#
 $id: kvstore/zarr_sharding_indexed
+title: Read/write adapter for the :ref:`zarr v3<zarr3-driver>` sharded_indexed format.
+description: JSON specification of the key-value store.
 allOf:
 - $ref: KvStore
 - type: object
@@ -21,7 +23,7 @@ allOf:
       $ref: driver/zarr3/CodecChain
     cache_pool:
       $ref: ContextResource
-      description: |-
+      description: |
         Specifies or references a previously defined `Context.cache_pool`.  It
         is normally more convenient to specify a default `~Context.cache_pool`
         in the `.context`.
@@ -35,13 +37,11 @@ allOf:
     data_copy_concurrency:
       $ref: ContextResource
       description: |-
-        Specifies or references a previously defined
-        `Context.data_copy_concurrency`.  It is normally more
-        convenient to specify a default `~Context.data_copy_concurrency` in
+        Specifies or references a previously defined `Context.data_copy_concurrency`.
+        It is normally more convenient to specify a default `~Context.data_copy_concurrency` in
         the `.context`.
       default: data_copy_concurrency
   required:
   - base
   - grid_shape
   - index_codecs
-title: JSON specification of zarr_sharding_indexed key-value store.

tensorstore/kvstore/zip/schema.yml

@@ -1,5 +1,7 @@
 $schema: http://json-schema.org/draft-07/schema#
 $id: kvstore/zip
+title: Read-only adapter for the ZIP archive format.
+description: JSON specification of the key-value store.
 allOf:
 - $ref: KvStore
 - type: object
@@ -8,22 +10,21 @@ allOf:
       const: zip
     base:
       $ref: KvStore
-      title: Underlying key-value store with path to shard.
+      title: Underlying key-value store with path to a ZIP file.
     cache_pool:
       $ref: ContextResource
       description: |-
         Specifies or references a previously defined `Context.cache_pool`.  It
-        is normally more convenient to specify a default `~Context.cache_pool`
+        is typically more convenient to specify a default `~Context.cache_pool`
         in the `.context`.
       default: cache_pool
     data_copy_concurrency:
       $ref: ContextResource
       description: |-
         Specifies or references a previously defined
-        `Context.data_copy_concurrency`.  It is normally more
+        `Context.data_copy_concurrency`.  It is typically more
         convenient to specify a default `~Context.data_copy_concurrency` in
         the `.context`.
       default: data_copy_concurrency
   required:
   - base
-title: JSON specification of zip key-value store.