Refactor README and add docs/api.md + docs/development.md

[Copilot]

README was being used as a session journal — handoff notes, nightly status bullets, priority lists, and debug instructions all mixed with the project description. Separate developer documentation didn't exist.

Changes

README.md

Stripped to essentials only: project description, the three living regions, core design principles, a four-command quick start, and a docs index table.

docs/api.md (new)

Full API reference for current public interfaces:

• Core data types — Page, Book, Volume, Shelf, Edge, MetroidNeighbor
• VectorStore / MetadataStore — all methods with signatures
• VectorBackend + createVectorBackend — backend detection and WASM fallback
• EmbeddingBackend, EmbeddingRunner, resolveEmbeddingBackend — provider resolution options
• ModelProfileResolver, buildModelProfileFromSeed — model profile construction
• createRoutingPolicy, resolveRoutingPolicyForModel — routing policy derivation

// Resolve a model profile and derive all routing dimensions in one call
const { modelProfile, routingPolicy } = resolveRoutingPolicyForModel(
  { modelId: "nomic-embed-text-v1.5" },
  { resolverOptions: { registry: { "nomic-embed-text-v1.5": { embeddingDimension: 768, contextWindowTokens: 8192 } } } },
);

docs/development.md (new)

Build/test/lint reference, runtime harness usage, benchmark commands, VS Code Electron debug configs (table), Docker lane setup, and the model-derived numeric guard with examples of what it blocks.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>README.md is a mess</issue_title>
<issue_description>The README.md file is presently a mess.
The only thing it should contain is the statement of what it is and brief instructions on using it.
However since the code base is in flux the instructions on use belong elsewhere in a docs folder.

We need to refactor and we also need to document what the API for this looks like (or at least will look like) for users of the system.</issue_description>

<agent_instructions>This should be straightforward, clean up the README and create proper docs for the API so that developers can actually use this when we are done.</agent_instructions>

Comments on the Issue (you are @copilot in this section)

• Fixes README.md is a mess #1

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[Copilot]

Copilot wasn't able to review any files in this pull request.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.