Skip to content

docs: cover ke-extraction and ke-ownership across the integrator site - #109

Merged
btspoony merged 13 commits into
mainfrom
docs/ke-capability-coverage
Sep 18, 2026
Merged

btspoony merged 13 commits into
mainfrom
docs/ke-capability-coverage

Conversation

@auto-wood

Copy link
Copy Markdown
Contributor

Summary

The integrator site now documents the two optional KE capability families the protocol ships. The connect pages already carried their remote face; the in-process half was missing, so a reader of the site alone could not learn that either family exists.

ke-extraction — in-process surface

  • reference/ops: new optional-op section with ExtractRequest / ExtractResponse field tables, the provisional-only admission rule, the run_id echo, and the extract versus extract→promote distinction; Scope selector gains the viewpoint row.
  • how-to/orchestrate-ops: orchestrateExtract(ports, request, runExtractor) in the orchestrator roster plus a worked example of the standalone ExtractionPort and the injected async extractor.
  • how-to/implement-adapter: a ke-extraction capability row and an ExtractionPort subsection beside the other optional families.
  • packages/quick-start: orchestrator and port naming in the integrator path.

ke-ownership — governance facts

  • reference/data-model: KnowledgeEntry.owner and KnowledgeEntry.disclosure rows plus an ownership-governance section stating the exact-match owner-private rule against Scope.viewpoint.
  • reference/protocol: the capability registry now lists all eight flags; the schema inventory is corrected to 34 committed schema files (2 common + 10 data + 16 ops + 6 connect) with the 21-file baseline subset stated beside it.
  • explanation/concepts and the home page: both ke-* flags named.
  • explanation/connect and how-to/multi-peer-routing: the two remote capability gates (an extract invoke needs negotiated ke-extraction; a viewpoint-bearing Scope needs ke-ownership on top of its row capability), each linking the connect reference; the native-binding and C/C++ overview pages point at the extraction surface.

Redundancy trim (bounded)

Four page-to-page restatements were replaced by links to the owning page: the explanation/connect opening paragraph, the connect-remote-adapter envelope-authentication bullets, the duplicated walkthrough in first-connect-session, and a restated Transport sentence in integrate-remote-adapter. The trimmed tutorial still walks its own goal end to end.

Every page was updated in EN and ZH together.

Verification

  • node tooling/docs/twin-parity.mjs — 24 twin pairs, 0 heading-structure mismatches
  • pnpm docs:build — clean
  • node tooling/docs/deadlink-check.mjs — 49 pages, 2785 anchor links and 68 fragment links, 0 dead, 0 broken
  • Three-seat code review over the branch diff: one initial Request Changes (a capability-table shorthand that invited a wrong adapter choice) plus two approvals; the finding and one suggestion were fixed and re-validated, no residual left open

Deferred (tracked on the project roadmap)

  • Moving the inline WsTransport and host.cpp bodies out of their how-to pages into committed examples
  • Consolidating the conceptual prose the connect reference restates beside its field tables

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk: low. Approved: docs-only integrator-site coverage of existing ke-extraction and ke-ownership facts; Cursor Bugbot and Cursor Security Agent were not present after the first poll, so those signals were skipped, and no other policy requires human review. No reviewers assigned.

Open in Web View Automation 

Sent by Cursor Approval Agent: Pull Request Router and Approver

@greptile-apps

greptile-apps Bot commented Sep 18, 2026 •

Copy link
Copy Markdown

RetriggerConfidence Score: 5/5

The PR appears safe to merge; no actionable new issue or outstanding previous finding remains.

Summary

The PR expands the English and Chinese integrator documentation for the optional ke-extraction and ke-ownership capabilities, updates protocol inventories and cross-page guidance, and restores workflow coverage for Markdown-only changes.

  • Documents extraction schemas, ports, orchestration, remote dispatch, and promotion.
  • Documents ownership fields, viewpoint filtering, and capability gates.
  • Keeps English and Chinese pages aligned while consolidating duplicated material behind owning reference pages.
  • Extends the docs workflow to run for Markdown changes outside docs/**.

Reviews (4) · Last reviewed commit: "ci(docs): cover all markdown changes"

Comment thread docs/reference/protocol.md Outdated
greptile-apps[bot]
greptile-apps Bot previously approved these changes Sep 18, 2026
@greptile-apps
greptile-apps Bot dismissed their stale review September 18, 2026 13:53

Dismissed because a newer commit was pushed; Greptile will re-review the current head.

Comment thread .github/workflows/ci.yml
@btspoony
btspoony merged commit 54c97d6 into main Sep 18, 2026
20 checks passed
@btspoony
btspoony deleted the docs/ke-capability-coverage branch September 18, 2026 14:35
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.

2 participants