docs and accounts (#241)

.github/workflows/ci.yaml

@@ -126,7 +126,7 @@ jobs:
       - name: Run tests
         run: cargo test --verbose
 
-  e2e:
+  examples:
     needs: build
     runs-on: ubuntu-latest
     steps:
@@ -174,7 +174,4 @@ jobs:
             ~/.cargo/git/db/
             target/
           key: ${{ needs.build.outputs.cache-key }}
-      - name: Lint intra docs links
-        run: cargo rustdoc -p firewood --lib -- -D rustdoc::broken-intra-doc-links
-      - name: Lint missing crate-level docs
-        run: cargo rustdoc -p firewood --lib -- -D rustdoc::missing-crate-level-docs
+      - run: RUSTDOCFLAGS="-D warnings" cargo doc --all --document-private-items --no-deps

firewood/src/db.rs

@@ -183,7 +183,7 @@ fn get_sub_universe_from_empty_delta(
 /// DB-wide metadata, it keeps track of the roots of the top-level tries.
 #[derive(Debug)]
 struct DbHeader {
-    /// The root node of the account model storage. (Where the values are [Account] objects, which
+    /// The root node of the account model storage. (Where the values are `Account` objects, which
     /// may contain the root for the secondary trie.)
     acc_root: DiskAddress,
     /// The root node of the generic key-value store.