Skip to content

Commit 454c1c0

Browse files
committed
docs: sync mainline architecture and knowledge workspace status
1 parent 67deb8a commit 454c1c0

7 files changed

Lines changed: 46 additions & 0 deletions

File tree

Interface Document.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,14 @@ Audit flow:
5252

5353
- Scoped retrieval is now represented by `KnowledgeQueryRequest.scope` and `KnowledgeCorpusScope`.
5454
- `AgentConversationResponse` remains backward-compatible: `assistantMessage` is still valid, while `answer`, `citations`, `memoryActions`, `trace`, and optional `assistantBlocks` provide richer grounded conversation state.
55+
- `AgentConversationKnowledgePoint` may now carry grouped/document-augmented evidence fields such as `atomIds`, `documentId`, `sourcePath`, `citations`, `matchedSpans`, and `matchCount`, while preserving the original top-level title/summary/citation shape.
56+
- Scoped query traces may now report `scopeSource: planner_scope_recovery` when title-like recovery intentionally switches from an incompatible explicit scope to a document-only recovery scope.
5557
- `/api/knowledge/conversation` remains the conversation entrypoint and supports current stream/sync compatibility behavior.
5658
- `/api/knowledge/conversation-memory/{list,add,search,delete,feedback}` exposes scoped conversation memory operations.
5759
- `POST /api/knowledge/export/workspace` exposes deterministic workspace export bundles backed by resource, index, workspace, session, workflow, memory, and render-materialization state.
5860
- Runtime governance payloads expose graphdb/vector rollout context, including `rolloutProfile`, graphdb connector health, vector acceleration strictness, and runbook checks.
61+
- The Knowledge Workspace frontend contract now also includes an in-pane scope selector, a compact conversation API status strip, file-first grouped hit rendering, and matched-span evidence rendering inside the focus pane. These are additive UI/runtime contracts over the existing backend payloads, not a replacement of public response fields.
62+
- `assistantBlocks` are no longer only transport wrappers around the same legacy answer string. Current Tauri-capable clients should expect intent-aware overview / explanation / evidence / memory / action sections while still honoring `assistantMessage` as the compatibility fallback.
5963
- Compatibility rule: new response fields must remain additive and optional; Godot/mobile paths must continue to use PNG-first materialized render artifacts instead of requiring direct SVG import.
6064

6165
---

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,11 @@ Unlike traditional "network" views that show a messy web of links, NoteConnectio
3030
## Current Mainline Architecture Status (2026-06-06)
3131

3232
- The current `main` branch has code-backed scoped retrieval, grounded conversation, durable resource/index/workspace/session/memory/export substrate, explicit export profiles, and PNG-first Godot/mobile render materialization.
33+
- The Knowledge Workspace is no longer only a thin chat shell over the global folder selector: it now has an in-pane scope switcher, a compact `/api/knowledge/conversation` status strip, grouped knowledge-point hits rendered as file-first entries, matched-span rendering in the focus pane, and explicit recovered-source visibility when `planner_scope_recovery` is used.
3334
- graphdb/sqlite and ANN/external connector paths are operational baselines, not production-closed release claims. Release closure still depends on repeated soak evidence, workload thresholds, recall/latency calibration, and strict rollout proof.
3435
- `npm run verify:foundation:release-evidence` now audits the latest sqlite soak and ANN release-gate JSON reports for freshness and passing gates before current-host evidence is used as release context; `npm run verify:foundation:release-evidence:strict` additionally requires repeated fresh valid history reports, is exposed in foundation readiness as `foundation_release_evidence_history`, and now passes on the current Windows host with sqlite `3/3` and ANN `3/3`. `npm run verify:foundation:release-evidence:multi-host` is now available when a release window needs at least two host keys per component, but current Windows-host evidence remains single-host.
3536
- Backward compatibility is preserved through additive response evolution: `assistantBlocks` can carry richer Tauri agent replies while legacy `assistantMessage` remains valid.
37+
- Tauri agent replies are now materially richer than the old plain-text path: the backend emits intent-aware overview / explanation / evidence summary / memory notice / next-action sections, while still preserving the old `assistantMessage` field for legacy clients.
3638
- The current architecture pressure is ownership reduction: `src/server.ts`, `src/learning/KnowledgeLearningPlatform.ts`, and large frontend host files remain the next simplification targets.
3739
- Current code-vs-plan details are tracked in [Architecture Progress Alignment and Mainline Plan (2026-06-06)](docs/solutions/architecture-progress-alignment-2026-06-06.md) and [Development Progress Dashboard](docs/diataxis/en/explanation/development-progress-dashboard.md).
3840

docs/en/Interface Document.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,15 @@ Current contract surfaces:
5656
- `assistantMessage` is still valid for legacy clients,
5757
- `answer`, `citations`, `knowledgePoints`, `memoryActions`, `summary`, and `trace` expose grounded conversation state,
5858
- optional `assistantBlocks` carries richer typed reply sections for clients that can render them.
59+
- `AgentConversationKnowledgePoint` may now include grouped/document-augmented fields such as `atomIds`, `documentId`, `sourcePath`, `citations`, `matchedSpans`, and `matchCount`.
60+
- Scoped query resolution may now expose `scopeSource: planner_scope_recovery` when a title-like recovery path intentionally leaves the original explicit corpus boundary and switches to a document-only recovery scope.
5961
- `/api/knowledge/conversation` supports the current conversation path, including stream-first clients and sync fallback behavior.
6062
- `/api/knowledge/conversation-memory/{list,add,search,delete,feedback}` exposes scoped conversation memory operations.
6163
- `/api/knowledge/workspace-readiness` exposes workspace/corpus readiness for scoped runtime decisions.
6264
- `POST /api/knowledge/export/workspace` exposes deterministic workspace export bundles backed by resource, index, workspace, session, workflow, memory, and render-materialization state.
6365
- Runtime governance endpoints and payloads expose graphdb/vector rollout context, including `rolloutProfile`, graphdb connector health, vector acceleration strictness, and runbook checks.
66+
- The Knowledge Workspace frontend contract now also includes an in-pane scope selector, a compact `/api/knowledge/conversation` status strip, grouped file-first hit rendering, and matched-span evidence rendering in the focus pane.
67+
- `assistantBlocks` are no longer only thin transport wrappers around the same plain answer string. Tauri-capable clients should now expect intent-aware overview / explanation / evidence / memory / action sections while still treating `assistantMessage` as the compatibility fallback.
6468

6569
Compatibility rules:
6670

docs/en/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,10 @@ Unlike traditional "network" views that show a messy web of links, NoteConnectio
2828
## Current Mainline Architecture Status (2026-06-06)
2929

3030
- Current `main` has code-backed scoped retrieval, grounded conversation, durable resource/index/workspace/session/memory/export substrate, explicit export profiles, and PNG-first Godot/mobile render materialization.
31+
- The Knowledge Workspace now includes an in-pane scope switcher, a compact conversation API status strip, grouped file-first knowledge-point hits, matched-span rendering in the focus pane, and explicit recovered-source visibility when `planner_scope_recovery` is used.
3132
- graphdb/sqlite and ANN/external connector paths are operational baselines. Production closure still requires repeated soak evidence, workload thresholds, recall/latency calibration, and strict rollout proof.
3233
- Compatibility remains additive: rich `assistantBlocks` can be used by newer clients while legacy `assistantMessage` stays valid.
34+
- Tauri reply organization is now intent-aware and section-based: overview, explanation, evidence summary, memory notice, and next-action guidance are emitted as structured blocks rather than one flat answer string.
3335
- The next architecture work is ownership reduction in `src/server.ts`, `src/learning/KnowledgeLearningPlatform.ts`, and large frontend host files.
3436
- Current code-vs-plan details: [Architecture Progress Alignment and Mainline Plan (2026-06-06)](../solutions/architecture-progress-alignment-2026-06-06.md) and [Development Progress Dashboard](../diataxis/en/explanation/development-progress-dashboard.md).
3537

docs/solutions/architecture-progress-alignment-2026-06-06.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,34 @@ Primary plan evidence:
7979
| Export/platform shell | Implemented baseline | export profiles, render materializer, workspace export bundle | Keep mobile/Godot export constraints explicit and test-backed. |
8080
| Governance and CI | Strong but not complete | docs gates, route/agent contracts, runtime verifiers, SBOM/sidecar gates | Keep evidence freshness and host-specific release gates separate from implementation-complete claims. |
8181

82+
### Follow-Through on Current `main`
83+
84+
The current local `main` has already moved beyond the initial 2026-06-06 documentation-only alignment slice.
85+
Subsequent local mainline commits, still preserving public runtime compatibility, added four concrete execution follow-through tracks:
86+
87+
1. **Foundation release evidence**
88+
- default freshness audit,
89+
- strict repeated-evidence audit,
90+
- opt-in multi-host audit,
91+
- readiness-exposed release aliases and repeated-evidence checks.
92+
2. **Frontend/runtime auth recovery**
93+
- stale sidecar settings authentication recovery in the frontend runtime bridge path.
94+
3. **Knowledge Workspace grounded-answer UX**
95+
- compact API health/status strip,
96+
- grouped document-level knowledge hits with `matchedSpans`,
97+
- direct evidence-first top-level answers instead of the old repeated “strongest match” template.
98+
4. **Scoped-retrieval recovery and workspace-local scope UX**
99+
- `planner_scope_recovery` when title-like hits exist outside the originally selected scope,
100+
- in-pane scope switching inside the Knowledge Workspace,
101+
- explicit recovered-source visibility when recovery is used.
102+
103+
These do not change the main planning order.
104+
They do change the current progress reading:
105+
106+
- P1 is no longer only “release evidence exists”; it now includes freshness, strict repeated evidence, and opt-in multi-host audit tooling.
107+
- P3/P4 are no longer only “assistant blocks exist”; they now include intent-aware section composition plus knowledge-workspace scope and grouped-hit UX that makes scoped grounded conversation materially usable in Tauri.
108+
- P2 and deeper ownership reduction are still the next structural pressure point, because these newer capabilities remain largely orchestrated through `src/server.ts`, `src/frontend/agent_workspace.js`, `src/frontend/workspace_panes.js`, and `KnowledgeLearningPlatform.ts`.
109+
82110
### Concrete Mainline Plan
83111

84112
#### P0: Keep documentation truth synchronized

docs/zh/Interface Document.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,15 @@
5555
- `assistantMessage` 对旧客户端仍有效,
5656
- `answer``citations``knowledgePoints``memoryActions``summary``trace` 暴露 grounded conversation 状态,
5757
- 可选 `assistantBlocks` 为能渲染 typed reply 的客户端提供 richer 分块回复。
58+
- `AgentConversationKnowledgePoint` 现在还可以携带按知识点/文档聚合后的字段,例如 `atomIds``documentId``sourcePath``citations``matchedSpans``matchCount`
59+
- scoped query 解析现在也可能返回 `scopeSource: planner_scope_recovery`:当 title-like recovery 故意离开原始显式 corpus 边界、切到 document-only recovery scope 时,会通过该字段显式暴露。
5860
- `/api/knowledge/conversation` 支持当前会话路径,包括 stream-first 客户端与 sync fallback 行为。
5961
- `/api/knowledge/conversation-memory/{list,add,search,delete,feedback}` 暴露 scoped conversation memory 操作。
6062
- `/api/knowledge/workspace-readiness` 暴露用于 scoped runtime 决策的 workspace/corpus readiness。
6163
- `POST /api/knowledge/export/workspace` 暴露 deterministic workspace export bundle,其数据来自 resource、index、workspace、session、workflow、memory 与 render-materialization 状态。
6264
- 运行时治理端点与 payload 暴露 graphdb/vector rollout 上下文,包括 `rolloutProfile`、graphdb connector health、vector acceleration strictness 与 runbook checks。
65+
- Knowledge Workspace 前端契约现在也包括工作区内 scope 切换器、紧凑的 `/api/knowledge/conversation` 状态条、按文件优先的 grouped hit 渲染,以及 focus pane 中的 matched-span 证据渲染。
66+
- `assistantBlocks` 已不再只是对同一段 plain answer 的薄运输包装。对于支持 Tauri rich reply 的客户端,现在应预期 intent-aware 的 overview / explanation / evidence / memory / action 分块,同时继续把 `assistantMessage` 视为兼容性 fallback。
6367

6468
兼容性规则:
6569

docs/zh/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@
2424
## 当前主线架构状态(2026-06-06)
2525

2626
- 当前 `main` 已具备代码支撑的 scoped retrieval、grounded conversation、持久化 resource/index/workspace/session/memory/export 底座、显式 export profiles,以及 Godot/mobile PNG-first 渲染物化边界。
27+
- 知识工作区已经不再只是套在全局文件夹选择器外面的薄壳:现在具备工作区内 scope 切换器、紧凑的 conversation API 状态条、按知识点聚合后的文件优先命中列表、focus pane 内的 matched-span 证据渲染,以及触发 `planner_scope_recovery` 时的 recovered source 可见性。
2728
- graphdb/sqlite 与 ANN/external connector 目前是 operational baseline。生产闭环仍需要多轮 soak 证据、工作负载阈值、recall/latency 校准与 strict rollout 证明。
2829
- 兼容性保持 additive:新客户端可以使用 richer `assistantBlocks`,legacy `assistantMessage` 仍有效。
30+
- Tauri reply 组织层现在已经是 intent-aware 的 section 化输出:overview、explanation、evidence summary、memory notice 与 next-action guidance 作为结构化块发出,而不再只有一段平铺 answer。
2931
- 下一阶段架构工作是缩减 `src/server.ts``src/learning/KnowledgeLearningPlatform.ts` 与大型前端宿主文件中的所有权压力。
3032
- 当前代码 / 方案详细对齐请查看 [架构推进对齐与主线推进方案(2026-06-06)](../solutions/architecture-progress-alignment-2026-06-06.md)[开发进度看板](../diataxis/zh/explanation/development-progress-dashboard.md)
3133

0 commit comments

Comments
 (0)