Giant pass: storage API docs, trust/consensus/routing code, category guides

Complete manual documentation cleanup for the storage stack and expand
category-level guides across the library.

Documentation (23 storage modules):
- Rewrite Methods sections in all storage-hypercore, storage-hyperbee,
  storage-autobase, and storage-hyperdrive api.md files from index.js
- Remove every "module-specific (see implementation)" placeholder in storage
- Fix bitfield-scheduler, bee-batch-write, bee-range-watch, drive-gc-sweep APIs

Category READMEs (modules/):
- trust-security, consensus-coordination, routing-advanced — tables + hub links
- MODULE_CATEGORIES.md typo fix (scaffold tier description)

Code:
- hyper-p2p-trust-graph: hasEdge(), nodeCount(), getStats with protocol
- hyper-p2p-circuit-breaker: listCircuitIds(), reset()
- hyper-p2p-distributed-lock: getStats merges metrics + active lock counts

Parent workspace (not in this repo) also received doc hubs for all 29
categories in docs/README.md and MODULE_DOC_PASS.md giant-pass tracker.

Co-authored-by: Cursor <[email protected]>
This commit is contained in:
Raven Scott
2026-05-21 00:27:46 -04:00
co-authored by Cursor
parent e43e2e83f1
commit 7cb1612e71
27 changed files with 459 additions and 682 deletions
@@ -20,57 +20,25 @@ const mod = new HyperP2PBeeRangeWatch(opts)
## Methods
### `attach(…)`
### `attach(bee) → this`
- **Returns:** module-specific (see implementation)
### `watch(gte, lte, cb)` / `watchRange(gte, lte, cb) → id`
- **Throws:** — (none in method body)
Register callback for key changes in `[gte, lte]`.
### `watchRange(…)`
- **Throws:** `gte and lte required`, `callback required`, `gte must be <= lte`
- **Returns:** module-specific (see implementation)
### `notify(key, value, op?)` / `emitChange(key, value, op = 'put') → number`
- **Throws:**
- `Error: gte and lte required`
- `Error: callback required`
- `Error: gte must be <= lte`
Deliver to matching watches; returns delivery count.
### `emitChange(…)`
### `unwatch(id) → boolean`
- **Returns:** module-specific (see implementation)
### `activeWatches()` / `listWatches() → array`
- **Throws:**
- `Error: key required`
### `getStats() → { watches, notifications, unwatch, active, protocol }`
### `unwatch(…)`
- **Returns:** module-specific (see implementation)
- **Throws:** — (none in method body)
### `activeWatches(…)`
- **Returns:** module-specific (see implementation)
- **Throws:** — (none in method body)
### `getStats(…)`
- **Returns:** module-specific (see implementation)
- **Throws:** — (none in method body)
### `ready(…)`
- **Returns:** module-specific (see implementation)
- **Throws:** — (none in method body)
### `close(…)`
- **Returns:** module-specific (see implementation)
- **Throws:** — (none in method body)
### `async ready()` / `async close()`
## Events