feat: Featureful documentation

subconsciousnetwork · Jul 1, 2023 · 78afa44 · 78afa44
1 parent a6208aa
commit 78afa44
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/release-please-config.json b/release-please-config.json
@@ -4,6 +4,7 @@
   "release-type": "rust",
   "bump-minor-pre-major": true,
   "bump-patch-for-minor-pre-major": true,
+  "last-release-sha": "39d0260c3fd2e4deb155f7eb60d460c0d76dae4f",
   "packages": {
     "rust/noosphere-api": {},
     "rust/noosphere-car": {},

diff --git a/rust/noosphere-storage/src/lib.rs b/rust/noosphere-storage/src/lib.rs
@@ -1,6 +1,7 @@
 //! This crate contains generic interfaces and concrete implementations to
 //! support a common API for data persistance in Noosphere on many different
-//! platforms.
+//! platforms. Current platforms include native targets (via disk-persisted K/V
+//! store) and web browsers (via IndexedDB).
 
 #[macro_use]
 extern crate tracing;

diff --git a/rust/noosphere/src/noosphere.rs b/rust/noosphere/src/noosphere.rs
@@ -1,3 +1,5 @@
+//! A high-level, batteries-included API for Noosphere embedders
+
 use anyhow::{anyhow, Result};
 use noosphere_core::{authority::Authorization, data::Did};
 use std::{collections::BTreeMap, path::PathBuf, sync::Arc};