Document a good portion of the code

CHANGELOG.md

@@ -1,6 +1,7 @@
 In Development
 --------------
 - Reduced the sizes of a number of streams & futures
+- Added doc comments to much of the code
 
 v0.4.0 (2024-07-09)
 -------------------

Cargo.toml

@@ -33,7 +33,7 @@ itertools = "0.13.0"
 memory-stats = "1.2.0"
 moka = { version = "0.12.8", features = ["future"] }
 percent-encoding = "2.3.1"
-pin-project-lite = "0.2.14"
+pin-project = "1.1.5"
 reqwest = { version = "0.12.5", default-features = false, features = ["json", "rustls-tls-native-roots"] }
 reqwest-middleware = "0.3.2"
 reqwest-retry = "0.6.0"

README.md

@@ -47,9 +47,16 @@ Features
 
 - Hierarchies served:
 
-    - `/dandisets/`: A view of Dandisets & assets (including Zarr entries, and
-      including version metadata as virtual `dandiset.yaml` files) in Dandi
-      Archive, retrieved via the Dandi Archive and S3 APIs
+    - `/dandisets/`: A view of Dandisets & assets in Dandi Archive, retrieved
+      via the Dandi Archive and S3 APIs
+
+        - Dandiset versions include a `dandiset.yaml` file as a top-level
+          resource.
+
+        - Zarr assets are represented as collections of their entries.
+
+        - HTML views of collections include links to version & asset metadata
+          on the API server.
 
     - `/zarrs/`: A view of all Zarrs in the Dandi Archive at various points in
       time, as recorded by/at <https://github.com/dandi/zarr-manifests>

src/consts.rs

@@ -1,3 +1,4 @@
+//! Constants and program-wide compile-time configuration
 use time::{format_description::FormatItem, macros::format_description};
 
 /// The "User-Agent" value sent in outgoing HTTP requests