Documentation index
Wording: Product capabilities follow the header of 产品规格.md; this page is navigation only. File names remain in Chinese.
Source docs/en/site/product-index.md
Wording: Product capabilities follow the header of 产品规格.md; this page is navigation only. File names remain in Chinese.
Primary source of truth
| Document | Purpose |
|---|---|
| Product specification | Product architecture, workspaces, agents, knowledge layers, API outline |
| Backend and Web design | REST decision source of truth for Web/mobile through the backend (section 9) |
Users and integration
| Document | Purpose |
|---|---|
| Product introduction | Target-user onboarding: positioning, value, capability overview, typical scenarios, and 5-minute start |
| Product handbook | Creating agents, knowledge base, embed, usage overview |
SDKs (sdk/ · four kinds)
| Directory | Purpose |
|---|---|
| sdk/ | Overview and how to choose among the four SDKs |
| sdk/host-embed/ | Host embed: deliverable integration docs + widget source |
| sdk/platform-plugin/ | Plugin apps: app-desktop iframe, Go/TS SDK, contract |
| sdk/agent-capability/ | Plugin tools: call APIs from Messages (skills + network capability pack) |
| sdk/appsdk/ | Workspace apps: app.json lightweight-app spec |
| Site integration notes | Host-page init, feature navigation, server-side token minting |
| SDK contract | Embed token, SSE, TypeScript types |
UI and delivery
| Document | Purpose |
|---|---|
| UI and layout | Visual rules, responsive breakpoints, A/B/C layouts, post-sign-in home |
| Win12-style theme spec | Reusable Win12 purple-blue Mica theme tokens (color, frosted glass, component recipes, framework wiring) |
| Implementation plan | Phased delivery and progress tracking |
| Memory forging and scheduled-task plan | MemoryForge completion + user-side scheduled tasks (aligned with OpenClaw Cron) |
| Implementation acceptance | Operator checklists per phase |
| Sidebar vs delivery phases | Sidebar menus aligned with plan phases |
Admin console
| Document | Purpose |
|---|---|
| Admin console | Feature modules, APIs, RBAC, system knowledge base, day-to-day ops appendix |
Mechanisms (docs/core-mechanisms/)
Entry: Mechanism index
| Document | Notes |
|---|---|
| Index-style docs and feedback loop | Two-level index and document-driven improvement loop |
| How agents call knowledge documents | How three layers of knowledge enter conversation |
| Standards library | Workspace regulations and management standards, crawl-pending-review, shared across plugins (product §3.2.2) |
| Check schemes | Machine-readable practice packs: from standards, driving check items (product §3.2.4) |
| Compliance practice checklist to machine-readable pack | Expert internal-review table → machine-readable pack → check scheme → questionnaire (product §3.2.2/§3.2.3/§3.2.4/§4.2.4) |
| Assets library | Workspace templates and forms, apply-and-use, plugin read-only (product §3.2.3) |
| Document cabinet | Finished reports and files to keep; multi-index browse; scheduled keep-each-period or latest-only (product §3.2.5) |
| Give a goal, find the path | User gives the goal, assistant finds the path; document cabinet auto-files when it can |
| AI knowledge-index rebuild rules | Generate index.json with AI |
| Agent conversation orchestration | Help vs work identities; per-round materials and tools (target) |
| Memory forging | Conversation archive and knowledge feedback |
| Agent memory | Profile, long-term memory, daily notes |
| Agent memos | Records stored by tag; look up when needed |
| Help action links | Main-site mindlink://action/… |
| Help-assistant conversation actions | Help assistant does the work in conversation (ChatOps) |
| Data-connection query accuracy | Agree the definition first, then run a predefined query |
| Workspace help one-liners | Action-assistant one-liner ranking |
| Unified conversation and contacts | Unified conversation, agent rental, workspace groups (product §4.6) |
| Agent team meetings | Agent teams, role decisions, publish tasks and hold meetings (product §4.9) |
| Service notifications | Service-notification entry, workspace/friend and other system events (draft) |
| Human support | Live human support: local seats, support teams, queue, conversation, ratings, and support desk |
| Tickets | Async tickets: submit, comments, close, rating (not time-critical) |
| Windowed conversation loading | Scroll up in a conversation and locate a question |
| Conversation reading mode and export | Reading mode and EPUB / PDF export |
| Conversation-pack import/export | Import/export conversation packs across servers |
| Workspace data residency | Main database and workspace-namespace placement |
| Skill composition spec | Skill logic contract, trigger notes, progressive disclosure, and UI conventions |
| Workspace apps | Lightweight workspace apps, invoke, create in conversation, API and desktop |
| Workspace capability packs | Assistant capability packs, tool mapping, and MCP |
| Workflows | Templates, flow definitions, publish to apps, todos |
| Workflows and compliance | On-site compliance-check templates and image judgment |
| Scheduled tasks | Reminders at a time and automatic execution |
| UI description spec | Hand-written app UI description (app.json); full build in sdk/appsdk/ |
Other
| Document | Purpose |
|---|---|
| ../website/README.md | Public site: Chinese/English marketing site + community forum; one Next service, single-image deploy |
| Mobile verification-code integration | SMS OTP integration |
| sdk/ | Four SDKs (host-embed / platform-plugin / agent-capability / appsdk) |
docs/agent-skills/ | Workspace skill notes (injected at runtime; not a user knowledge directory) |
Removed or merged (do not cite old English names)
| Old filename | Where it went |
|---|---|
| 产品规格.md | → 产品规格.md |
后端与Web设计.md | → 后端与Web设计.md |
嵌入SDK契约.md and similar | → sdk/host-embed/ |
docs/embed/ | → sdk/host-embed/ (old path keeps a redirect) |
docs/appsdk / docs/pluginsdk / docs/embedsdk | → sdk/ four subdirectories (old paths keep redirects) |
core-mechanisms/平台插件SDK.md | → sdk/platform-plugin/README.md (old path keeps a redirect) |
管理员端规格.md / ADMIN_CONSOLE_RUNBOOK.md | → 管理员端规格.md (ops folded into the appendix) |
实施计划.md / 实施验收.md | → 实施计划.md / 实施验收.md |
| 产品手册.md | → 产品手册.md |
侧栏与实施阶段对照.md | → 侧栏与实施阶段对照.md |
| 界面与布局.md and three other layout docs | → 界面与布局.md |
English mechanism docs under core-mechanisms/ | → Chinese names listed in Mechanism index |