Skip to content

docs: realign all docs with knowledge-base refactor#100

Merged
erichare merged 1 commit intomainfrom
docs/kb-refactor
Apr 27, 2026
Merged

docs: realign all docs with knowledge-base refactor#100
erichare merged 1 commit intomainfrom
docs/kb-refactor

Conversation

@erichare
Copy link
Copy Markdown
Collaborator

Summary

Comprehensive doc pass following PR #99 (catalog/vector-store →
knowledge-base + chunking/embedding/reranking services). Every
narrative reference to the legacy model has been rewritten around
the new shape, route tables and field names match the runtime, and
the historical phases stay in the roadmap so the audit trail is
intact.

Files updated

  • Top-level README — at-a-glance, architecture diagram, full
    route table.
  • docs/overview, docs/architecture, docs/api-spec — product
    narrative, runtime model, HTTP contract narrative.
  • docs/workspaces — cascade rules, KB ↔ service binding,
    example session.
  • docs/playground — KB-driven dispatch, hybrid + rerank toggles
    default off the KB, ingest from the workspace UI.
  • docs/configuration — control-plane storage scope phrasing.
  • docs/cross-replica-jobs — fix module path to
    kb-documents.ts.
  • docs/conformance — current fixture inventory.
  • docs/green-boxes, docs/roadmap — runtime status, Phase KB
    summary.
  • runtimes/README, apps/web/README — directory + panel + hook
    • page layouts.
  • runtimes/python/README, runtimes/java/README — implementation
    order and route scaffolding aligned with the new model. (Java
    and Python SCHEMA_NOTES.md were already current.)

Test plan

  • No code changes — docs only.
  • Reviewer skim of the rewritten narrative sections.
  • Reviewer confirms route names match the runtime's actual
    OpenAPI surface.

Catalogs and vector-store descriptors have been replaced by knowledge
bases that compose chunking + embedding + reranking services. The KB
auto-provisions its underlying vector collection on create and drops
it on delete. This pass walks the full doc set:

- Top-level README, docs/overview, docs/architecture, docs/api-spec,
  docs/workspaces, docs/playground, docs/configuration: route table,
  product narrative, scoping rules, dispatch model, control-plane
  schema rewritten around KBs and execution services.
- docs/cross-replica-jobs: fix the async-ingest module reference to
  kb-documents.ts.
- docs/conformance: update fixture inventory to the current corpus
  (workspace-only after the refactor).
- docs/green-boxes, docs/roadmap: update runtime status, swap the
  contract route table, add a "Phase KB" entry summarizing the
  refactor.
- runtimes/README, apps/web/README: realign to the new components,
  hooks, pages, panels.
- runtimes/python/README, runtimes/java/README: update implementation
  order and route scaffolding to the new shape; SCHEMA_NOTES.md was
  already current.
@erichare erichare merged commit 7ecc0ff into main Apr 27, 2026
13 of 14 checks passed
@erichare erichare deleted the docs/kb-refactor branch April 27, 2026 20:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant