Bug: docs mismatch #7

New issue

Closed

opened 2026-06-14 10:23:51 +00:00 by fatmaebrahim · 0 comments

fatmaebrahim commented

2026-06-14 10:23:51 +00:00

Member

Description:

The API was refactored from a namespace-based model to a workspace-based model, but the docs were never updated.
For example:

API.md & SDK.md still document the old namespace.* API — code now uses workspace.* as the primary abstraction. All index/search methods take workspace not namespace.
~50 new methods completely undocumented — workspaces, collections, QA, ontology, KVS, vectors, jobs, logs, and memory.search.
SDK.md references wrong crate name (hero_memory → should be hero_memory_sdk) and shows non-existent types/methods.
OpenRPC spec missing 6 implemented methods.
Quality level names and numbering changed but docs show old values.

### Description: The API was refactored from a namespace-based model to a workspace-based model, but the docs were never updated. For example: - API.md & SDK.md still document the old namespace.* API — code now uses workspace.* as the primary abstraction. All index/search methods take workspace not namespace. - ~50 new methods completely undocumented — workspaces, collections, QA, ontology, KVS, vectors, jobs, logs, and memory.search. - SDK.md references wrong crate name (hero_memory → should be hero_memory_sdk) and shows non-existent types/methods. - OpenRPC spec missing 6 implemented methods. - Quality level names and numbering changed but docs show old values.