From d4ff31d2f9347bc1ccdf44801cb39b2cf1dd45c0 Mon Sep 17 00:00:00 2001 From: "qiansicheng.621" Date: Mon, 19 Oct 2026 12:44:14 +0000 Subject: [PATCH] docs: embed the intro video and simplify the README repository layout Play the four-minute introduction video at the top of both READMEs, and replace the per-package table with a short layout that names the one package users install. Co-Authored-By: Claude Opus 5.5 --- README.md | 43 ++++++++++++++++++++----------------------- README.zh-CN.md | 35 +++++++++++++++-------------------- 2 files changed, 35 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index c4a2a46d..c786b1ee 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,10 @@ only when they need exact detail. [Contributing](./CONTRIBUTING.md) · [Release Notes](./CHANGELOG.md) + + +[Watch the 4-minute introduction to Context](https://github.com/context4ai/portal/releases/download/intro-video-2026-10-15/context4ai-v2-with-music.mp4) + ## Why Context - **Knowledge as an index.** Indexer Skills extract what matters from each @@ -137,29 +141,22 @@ projects ([source](https://github.com/context4ai/portal)). | [Source Graph](https://github.com/context4ai/sourcegraph) | Code search and reading at pinned Git revisions; Context reads code evidence through it remotely | | [Portal](https://github.com/context4ai/portal) | [context4ai.org](https://context4ai.org): the homepage and the documentation site | -## Repository map - -| Module | Role | Documentation | -|---|---|---| -| `@c4a/context` | Declarative project SDK for sources, phases, review gates and outputs | [English](./packages/context/README.md) · [中文](./packages/context/README.zh-CN.md) | -| `@c4a/context-cli` | Local workflow runtime, Agent plugin and website builder | [English](./packages/context-cli/README.md) · [中文](./packages/context-cli/README.zh-CN.md) | -| `@c4a/core` | Shared schemas, identities, errors and extraction contracts | [English](./packages/core/README.md) · [中文](./packages/core/README.zh-CN.md) | -| `@c4a/extract` | Language-plugin protocol and repository extraction runner | [English](./packages/extract/README.md) · [中文](./packages/extract/README.zh-CN.md) | -| `@c4a/extract-ts` | TypeScript/JavaScript and TSX/JSX structure extraction | [English](./packages/extract-ts/README.md) · [中文](./packages/extract-ts/README.zh-CN.md) | -| `@c4a/extract-go` | Optional Go structure extraction | [English](./packages/extract-go/README.md) · [中文](./packages/extract-go/README.zh-CN.md) | -| `@c4a/extract-rush` | Optional Rush workspace structure index | [English](./packages/extract-rush/README.md) · [中文](./packages/extract-rush/README.zh-CN.md) | -| `@c4a/extract-mdx` | Optional MDX component and example catalog | [English](./packages/extract-mdx/README.md) · [中文](./packages/extract-mdx/README.zh-CN.md) | -| `@c4a/extract-proto` | Optional Protocol Buffers IDL catalog | [English](./packages/extract-proto/README.md) · [中文](./packages/extract-proto/README.zh-CN.md) | -| `@c4a/extract-thrift` | Optional Apache Thrift IDL catalog | [English](./packages/extract-thrift/README.md) · [中文](./packages/extract-thrift/README.zh-CN.md) | -| `@c4a/extract-contract` | Optional OpenAPI and GraphQL contract catalog | [English](./packages/extract-contract/README.md) · [中文](./packages/extract-contract/README.zh-CN.md) | -| `@c4a/extract-sql` | Optional dialect-bound SQL evidence | [English](./packages/extract-sql/README.md) · [中文](./packages/extract-sql/README.zh-CN.md) | -| `@c4a/extract-style` | Optional CSS and SCSS evidence | [English](./packages/extract-style/README.md) · [中文](./packages/extract-style/README.zh-CN.md) | -| `context-evidence-wasm` | Source Graph read plugin that attaches registered section sources | [English](./packages/context-evidence-wasm/README.md) | -| `@c4a/dev-cli` | Repository development and release menu | [English](./packages/dev-cli/README.md) · [中文](./packages/dev-cli/README.zh-CN.md) | -| `@c4a/tui` | Shared terminal components for development tools | [English](./packages/tui/README.md) · [中文](./packages/tui/README.zh-CN.md) | - -[Module Layout](https://context4ai.org/context/pages/48ba914060b8913ca26c053abac47fac.html) -explains how these packages depend on each other and where a change lands; +## Repository layout + +You install one package, `@c4a/context-cli`. It provides the `context` command +and the Agent plugin, and bundles the code extractors. Knowledge workspaces it +creates depend on `@c4a/context`. + +| Path | Contents | +|---|---| +| [`packages/context-cli`](./packages/context-cli) | `@c4a/context-cli`: the CLI, workflow runtime, Agent plugin and website builder | +| [`packages/context`](./packages/context) | `@c4a/context`: the SDK a workspace's `src/index.ts` uses to declare sources and outputs | +| [`plugins/context`](./plugins/context) | Skills and Indexers shipped in the Agent plugin | +| `packages/core`, `packages/extract*` | Shared contracts and language extractors bundled into the CLI | +| `packages/dev-cli`, `packages/tui` | Tools for developing and releasing this repository | + +Each package has its own README. [Module Layout](https://context4ai.org/context/pages/48ba914060b8913ca26c053abac47fac.html) +explains how the packages depend on each other and where a change lands; [ARCHITECTURE.md](./ARCHITECTURE.md) covers the internals. ## Documentation diff --git a/README.zh-CN.md b/README.zh-CN.md index 4cf601cc..7b6d011b 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -15,6 +15,10 @@ Context 把代码仓库、文档、笔记和会话整理成经过审阅、带版 [参与贡献](./CONTRIBUTING.md) · [发布说明](./CHANGELOG.md) + + +[观看 4 分钟 Context 介绍视频](https://github.com/context4ai/portal/releases/download/intro-video-2026-10-15/context4ai-v2-with-music.mp4) + 文档站与英文共用同一地址，按浏览器语言或手动选择显示中文。 ## 为什么用 Context @@ -96,26 +100,17 @@ Context 本身不调用模型。用户负责目标、来源权限与审阅决定 ## 仓库结构 -| 模块 | 角色 | 文档 | -|---|---|---| -| `@c4a/context` | 声明来源、阶段、审阅门禁与产物的项目 SDK | [English](./packages/context/README.md) · [中文](./packages/context/README.zh-CN.md) | -| `@c4a/context-cli` | 本地工作流运行时、Agent 插件与网站构建 | [English](./packages/context-cli/README.md) · [中文](./packages/context-cli/README.zh-CN.md) | -| `@c4a/core` | 共享 Schema、身份、错误与抽取契约 | [English](./packages/core/README.md) · [中文](./packages/core/README.zh-CN.md) | -| `@c4a/extract` | 语言插件协议与仓库抽取运行器 | [English](./packages/extract/README.md) · [中文](./packages/extract/README.zh-CN.md) | -| `@c4a/extract-ts` | TypeScript/JavaScript 与 TSX/JSX 结构抽取 | [English](./packages/extract-ts/README.md) · [中文](./packages/extract-ts/README.zh-CN.md) | -| `@c4a/extract-go` | 可选的 Go 结构抽取 | [English](./packages/extract-go/README.md) · [中文](./packages/extract-go/README.zh-CN.md) | -| `@c4a/extract-rush` | 可选的 Rush 工作区结构索引 | [English](./packages/extract-rush/README.md) · [中文](./packages/extract-rush/README.zh-CN.md) | -| `@c4a/extract-mdx` | 可选的 MDX 组件与示例目录 | [English](./packages/extract-mdx/README.md) · [中文](./packages/extract-mdx/README.zh-CN.md) | -| `@c4a/extract-proto` | 可选的 Protocol Buffers IDL 目录 | [English](./packages/extract-proto/README.md) · [中文](./packages/extract-proto/README.zh-CN.md) | -| `@c4a/extract-thrift` | 可选的 Apache Thrift IDL 目录 | [English](./packages/extract-thrift/README.md) · [中文](./packages/extract-thrift/README.zh-CN.md) | -| `@c4a/extract-contract` | 可选的 OpenAPI 与 GraphQL 契约目录 | [English](./packages/extract-contract/README.md) · [中文](./packages/extract-contract/README.zh-CN.md) | -| `@c4a/extract-sql` | 可选的方言绑定 SQL 证据 | [English](./packages/extract-sql/README.md) · [中文](./packages/extract-sql/README.zh-CN.md) | -| `@c4a/extract-style` | 可选的 CSS 与 SCSS 证据 | [English](./packages/extract-style/README.md) · [中文](./packages/extract-style/README.zh-CN.md) | -| `context-evidence-wasm` | 为已登记小节附带来源的 Source Graph 读取插件 | [English](./packages/context-evidence-wasm/README.md) | -| `@c4a/dev-cli` | 仓库开发与发布菜单 | [English](./packages/dev-cli/README.md) · [中文](./packages/dev-cli/README.zh-CN.md) | -| `@c4a/tui` | 开发工具共用的终端组件 | [English](./packages/tui/README.md) · [中文](./packages/tui/README.zh-CN.md) | - -[模块布局](https://context4ai.org/context/pages/48ba914060b8913ca26c053abac47fac.html)说明这些包之间的依赖以及改动落在哪里；内部实现见 [ARCHITECTURE.md](./ARCHITECTURE.md)。 +只需安装一个包：`@c4a/context-cli`。它提供 `context` 命令与 Agent 插件，并内置代码抽取器；它创建的知识工作区依赖 `@c4a/context`。 + +| 路径 | 内容 | +|---|---| +| [`packages/context-cli`](./packages/context-cli) | `@c4a/context-cli`：CLI、工作流运行时、Agent 插件与网站构建 | +| [`packages/context`](./packages/context) | `@c4a/context`：工作区 `src/index.ts` 用来声明来源与产物的 SDK | +| [`plugins/context`](./plugins/context) | 随 Agent 插件发布的技能与 Indexer | +| `packages/core`、`packages/extract*` | 共享契约与语言抽取器，打包进 CLI | +| `packages/dev-cli`、`packages/tui` | 本仓库的开发与发布工具 | + +每个包都有自己的 README。[模块布局](https://context4ai.org/context/pages/48ba914060b8913ca26c053abac47fac.html)说明这些包之间的依赖以及改动落在哪里；内部实现见 [ARCHITECTURE.md](./ARCHITECTURE.md)。 ## 文档