feat(docs): add bilingual package documentation site

2026-09-20 15:53:28 +08:00
parent 60f6f1fb1a
commit dc80bd8ae0
111 changed files with 6531 additions and 0 deletions
@@ -0,0 +1,29 @@
+---
+title: Overview
+description: Understand the Search package data boundary, interactions, and use cases.
+order: 1
+toc:
+  - id: package-role
+    title: Package role
+  - id: capabilities
+    title: Capabilities
+  - id: design-boundary
+    title: Design boundary
+---
+
+## Package role {#package-role}
+
+`@workspace/search` provides an application-search surface and its state management. The host supplies data through `SearchAdapter`; Search owns the query lifecycle, pagination, result presentation, selection interactions, and recent searches.
+
+## Capabilities {#capabilities}
+
+- Connect any HTTP API, database, command registry, or local index through an adapter.
+- Present results in domain groups and merge paginated data.
+- Cancel stale requests with `AbortSignal`.
+- Keep recent searches with configurable local persistence.
+- Provide a `Mod+K` shortcut plus empty, loading, and error states.
+- Ship `en-US` and `zh-Hans` message catalogs.
+
+## Design boundary {#design-boundary}
+
+Search does not choose the data source or perform navigation. The application implements the adapter and interprets each result's `payload` in `onSelect`.