Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 87 additions & 0 deletions docs/wiki/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# GitHub Wiki text sources

[中文](README.zh-CN.md)

This directory contains reviewable OpenBitFun 1.0 Wiki text. The publishable
Markdown is in `pages/`; `_Sidebar.md` and `_Footer.md` are Wiki navigation files.
There are no screenshot assets in this update. The bilingual screenshot checklist
records pending topics and capture requirements for a later contribution.

## Read and review

- [Home](pages/Home.md) / [中文首页](pages/首页.md)
- [Harness selection](pages/Agent-Modes.md) / [Harness 与智能体](pages/Agent-模式.md)
- [Sessions and goals](pages/Sessions-and-Goals.md) / [会话与持续目标](pages/会话与持续目标.md)
- [Scheduling](pages/Tasks-and-Automation.md) / [定时任务](pages/任务板与定时任务.md)
- [Remote guide](pages/Remote-and-Multi-device.md) / [远程指南](pages/远程与多设备.md)
- [Peer Device Mode](pages/Peer-Device-Mode.md) / [设备控制](pages/Peer-Device-Mode-中文.md)
- [Detached Dispatch](pages/Detached-Dispatch.md) / [远程派发](pages/远程任务派发.md)
- [Voice](pages/Voice-and-Realtime.md) / [语音](pages/语音与实时通话.md)
- [Screenshot checklist](pages/Screenshot-Checklist.md) / [截图清单](pages/截图清单.md)

The page bodies intentionally use extensionless Wiki links such as `(Home)`.
These resolve after publication to the Wiki, not as ordinary `.md` links in the
main repository. Use the file browser or this index during PR review. Keep page
filenames stable so existing Wiki URLs and cross-language links continue working.

Text is based on v1.0.0 documentation and development revision f72a28eb8, checked
on 2026-09-18. Review of source documentation is not runtime or remote scenario
testing. The Playbook remains the detailed, source-backed feature/settings
reference; Wiki pages provide conceptual and scenario-oriented guidance.

## Verification

From the main repository root:

```bash
node docs/wiki/check-links.mjs
pnpm run check:repo-hygiene
git diff --check
```

The focused check validates Wiki targets, language counterparts, local paths for
versioned source references, and screenshot topic/placeholder consistency. It does
not verify remote URLs, image availability, or application behavior.

## Publication is separate from PR merge

GitHub does not provide native pull requests for a `.wiki.git` repository.
The [Wiki editing guide](https://docs.github.com/en/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages)
describes editing/cloning the separate Git repository; Wiki PR support is tracked
in [GitHub Community](https://github.com/orgs/community/discussions/50163).

Merge text changes into the main repository through a normal PR. A maintainer
with Wiki write access must then review and publish them separately. This update
adds no automatic synchronization, workflow, credential, or permission changes.
The main repository's `GITHUB_TOKEN` must not be assumed to grant Wiki write access.

The upstream Wiki snapshot reviewed for this refresh is
`f143e0b13a631909a3aa6818d43646c95a8a9b83`.

To publish, start from a fresh Wiki clone and compare its HEAD with that snapshot.
If it differs, stop and reconcile intervening edits before copying any pages.
Work from the reviewed main-repository revision, not an unreviewed working copy.

```bash
# Run from the reviewed main-repository checkout.
wiki_publish_dir=$(mktemp -d)
git clone https://github.com/GCWing/OpenBitFun.wiki.git "$wiki_publish_dir/wiki"
git -C "$wiki_publish_dir/wiki" log -1 --format=%H
```

Only after checking the snapshot and reconciling any newer Wiki changes:

```bash
cp docs/wiki/pages/*.md "$wiki_publish_dir/wiki/"
git -C "$wiki_publish_dir/wiki" status --short
git -C "$wiki_publish_dir/wiki" diff --check
git -C "$wiki_publish_dir/wiki" diff
git -C "$wiki_publish_dir/wiki" add -- '*.md'
git -C "$wiki_publish_dir/wiki" commit -m "docs: refresh OpenBitFun 1.0 wiki text"
git -C "$wiki_publish_dir/wiki" push origin HEAD:master
```

Copy only `pages/*.md`, not this README or the checker. Do not delete unlisted
pages, force-push, or overwrite intervening edits. Review the exact diff before
pushing. After publication, inspect both language home pages, sidebar, and links.
Screenshots remain a separate follow-up and are not a prerequisite for this text PR.
47 changes: 47 additions & 0 deletions docs/wiki/README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# GitHub Wiki 文字来源与发布

[English](README.md)

此目录用于通过主仓库 PR 审阅 OpenBitFun 1.0 Wiki 文字。可发布的 Markdown
位于 `pages/`,包含侧边栏和页脚;本次不添加截图素材,只保留截图占位与清单。

## 阅读入口

- [首页](pages/首页.md)与[产品全景](pages/产品全景.md)
- [Harness 与智能体](pages/Agent-模式.md)
- [会话与持续目标](pages/会话与持续目标.md)
- [任务板与定时任务](pages/任务板与定时任务.md)
- [远程与多设备](pages/远程与多设备.md)、[设备控制](pages/Peer-Device-Mode-中文.md)、[远程派发](pages/远程任务派发.md)
- [语音与实时通话](pages/语音与实时通话.md)
- [待补截图清单](pages/截图清单.md)

正文保留 Wiki 使用的无扩展名链接,如 `(首页)`。它们发布到 Wiki 后才按 Wiki
页面解析,不是主仓库中的普通 `.md` 链接;审阅时使用文件列表或此索引。
保留原页面文件名,以兼容旧 URL 和中英文互链。

核验基于 v1.0.0 文档及开发版本 f72a28eb8,日期为 2026-09-18;源码文档核对
不等于运行或远程实测。Playbook 继续提供完整功能/设置参考,Wiki 提供概念与场景教程。

## 检查与发布

在主仓库根目录运行:

```bash
node docs/wiki/check-links.mjs
pnpm run check:repo-hygiene
git diff --check
```

检查器校验 Wiki 目标、中英文互链、版本化源码引用的本地文件与截图主题/占位一致性,
不验证线上 URL、图片加载或应用行为。

GitHub Wiki 使用独立的 `.wiki.git` 仓库,没有原生 PR 合并流程。
本 PR 合入主仓库后,不会自动更新线上 Wiki。需要拥有 Wiki 写权限的维护者,
另行核对并发布。本次不引入自动同步、工作流、凭据或权限变更。

本次核对的上游 Wiki 提交为 `f143e0b13a631909a3aa6818d43646c95a8a9b83`。
发布前应新克隆 Wiki,检查 HEAD;若已有新提交,停止复制并先整合新增修改。
仅从已审阅的主仓库版本复制 `pages/*.md`,不复制 README 或检查器,不删除未列出的
页面,不强制推送。具体命令见[英文发布指南](README.md#publication-is-separate-from-pr-merge)。

发布后检查双语首页、导航和链接。截图以后单独补充,不阻塞本次文字 PR。
67 changes: 67 additions & 0 deletions docs/wiki/check-links.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
import { existsSync, readFileSync, readdirSync } from 'node:fs';
import path from 'node:path';
import { fileURLToPath } from 'node:url';

const wikiRoot = fileURLToPath(new URL('./pages/', import.meta.url));
const repoRoot = fileURLToPath(new URL('../../', import.meta.url));
const pages = readdirSync(wikiRoot).filter(name => name.endsWith('.md'));
const errors = [];
const pending = new Map();
const checklistTopics = [];

for (const name of pages) {
const content = readFileSync(path.join(wikiRoot, name), 'utf8');
for (const [, target] of content.matchAll(/\]\(([^)]+)\)/g)) {
if (/^(https?:|#)/.test(target)) {
const source = target.match(/^https:\/\/github\.com\/GCWing\/OpenBitFun\/blob\/v1\.0\.0\/([^#]+)/);
if (source && !existsSync(path.join(repoRoot, decodeURIComponent(source[1])))) {
errors.push(`${name}: missing source reference ${source[1]}`);
}
continue;
}
const page = decodeURIComponent(target.split('#')[0]);
if (!existsSync(path.join(wikiRoot, `${page}.md`))) {
errors.push(`${name}: missing Wiki target ${target}`);
}
}
if (!name.startsWith('_')) {
const counterpart = content.split('\n')[0].match(/\]\(([^)]+)\)/)?.[1];
const counterpartPath = counterpart && path.join(wikiRoot, `${counterpart}.md`);
if (!counterpartPath || !existsSync(counterpartPath)) {
errors.push(`${name}: missing language counterpart`);
} else {
const firstLine = readFileSync(counterpartPath, 'utf8').split('\n')[0];
if (!firstLine.includes(`](${name.slice(0, -3)})`)) {
errors.push(`${name}: counterpart does not link back`);
}
}
}
if (name === 'Screenshot-Checklist.md' || name === '截图清单.md') {
checklistTopics.push(new Set([...content.matchAll(/^\| (S\d+) \|/gm)].map(m => m[1])));
}
for (const line of content.split('\n').filter(line => /^> (Screenshot pending:|待补截图:)/.test(line))) {
for (const id of line.match(/S\d+/g) ?? []) {
const locations = pending.get(id) ?? new Set();
locations.add(name);
pending.set(id, locations);
}
}
}

const [english, chinese] = checklistTopics;
if (!english || !chinese || english.size === 0 || english.size !== chinese.size || [...english].some(id => !chinese.has(id))) {
errors.push('Screenshot checklist topics differ between languages or are empty');
}
for (const id of english ?? []) {
if (pending.get(id)?.size !== 2) errors.push(`${id}: expected one placeholder in each language`);
}
for (const id of pending.keys()) {
if (!english?.has(id)) errors.push(`${id}: placeholder absent from screenshot checklist`);
}

if (errors.length) {
console.error(errors.join('\n'));
process.exitCode = 1;
} else {
console.log(`Wiki checks passed: ${pages.length} Markdown files, ${pending.size} screenshot topics.`);
}
37 changes: 37 additions & 0 deletions docs/wiki/pages/Agent-Modes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
[English] | [简体中文](Agent-模式) · [Home](Home)

# Harnesses and Agent selection

## Choose how the task runs

OpenBitFun 1.0 exposes four general Harnesses. They apply across coding, research, writing, and analysis; choose by the collaboration you need, not only by output format.

| Harness | When to choose it | Example |
| --- | --- | --- |
| Minimal | Clear scope and quick iteration | “Explain this function, then answer my follow-up.” |
| Standard | Several dependent steps | “Analyze these files, propose changes, implement them, and verify.” |
| Ultimate | Demanding investigation or coordinated work | “Investigate this system and compare approaches before implementation.” |
| Creative | Build or extend your workspace | “Create a Mini App for repository insights.” |

Creative can work on client UI and runtime capabilities through its available tools. Distinguish installed-client customization from changing a source checkout; source changes still need the normal build and review workflow. Review requested access and keep a recovery path.

## Select a Harness or specialist Agent

1. Create a session in the intended project or assistant workspace.
2. Open the session execution selector in the chat input menu.
3. Choose a Harness, or select a visible specialist/custom Agent.
4. Check the model and permission settings before sending the first request.

The Harness is selected before the first turn. Once a session has started, choosing another execution profile asks to start a new session rather than silently changing the current run. Legacy sessions also retain their existing execution identity.

## Harness, Agent, tool, and workflow are different

A custom Agent can have its own instructions, model choice, tools, Skills, and read-only constraints. Browser automation and computer interaction are capabilities. Planning, debugging, and research are also tasks you can request in ordinary language.

Older guides listed Agentic, Plan, Debug, Multitask, Cowork, Computer Use, Deep Research, Team, and Claw as equivalent modes. That list is not the current general Harness chooser. Some names remain specialist identities or compatibility identifiers; an old name is not evidence of a current mode button.

For “plan first,” explicitly ask for a proposal without edits. Harness selection itself is not permission to implement, publish, or perform destructive actions.

[Agent configuration](Customize-and-Extend) · [Sessions](Sessions-and-Goals)

> Screenshot pending: S03 — Harness chooser; S04 — started-session confirmation.
37 changes: 37 additions & 0 deletions docs/wiki/pages/Agent-模式.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
[简体中文] | [English](Agent-Modes) · [首页](首页)

# Harness 与智能体选择

## 选择任务的推进方式

OpenBitFun 1.0 提供四种通用 Harness。它们可以用于编程、调研、写作和分析;应按协作方式选择,而不是只按成果格式选择。

| Harness | 何时选择 | 示例 |
| --- | --- | --- |
| Minimal | 范围明确、需要快速反馈 | “解释这个函数,再回答我的追问。” |
| Standard | 有多个依赖步骤 | “分析这些文件,提出改动,实施并验证。” |
| Ultimate | 复杂调查或协调工作 | “调查这个系统,比较方案,再实施。” |
| Creative | 创建或扩展工作空间 | “制作一个仓库洞察 Mini App。” |

Creative 可通过可用工具修改客户端界面与运行时能力。要区分已安装客户端定制和修改源码仓库;源码修改仍需正常构建与审查。确认所需权限,并保留恢复路径。

## 选择 Harness 或专门智能体

1. 在目标项目或助理工作区新建会话。
2. 打开聊天输入菜单中的会话执行选择器。
3. 选择 Harness,或选择当前可见的专门/自定义智能体。
4. 发送第一条消息前,核对模型与权限设置。

Harness 在首轮任务前选择。会话开始后,改选其他执行配置会要求确认新建会话,而不是悄悄改变当前运行方式;旧会话也保留其既有执行身份。

## 不要混淆 Harness、智能体、工具和流程

自定义智能体可以配置角色指令、模型、工具、Skills 与只读限制。浏览器自动化、电脑操作是能力;规划、调试、调研也可以直接用自然语言提出。

旧指南曾将 Agentic、Plan、Debug、Multitask、Cowork、Computer Use、Deep Research、Team、Claw 并列为模式。这不是当前通用 Harness 选择器。一些名称仍作为专门角色或兼容标识保留,不能据此推断存在同名模式按钮。

如果希望“先规划”,明确说明“先给方案,不要修改”。选择 Harness 本身不构成实施、发布或破坏性操作的授权。

[智能体配置](自定义与扩展) · [会话管理](会话与持续目标)

> 待补截图:S03 — Harness 选择器;S04 — 已开始会话的改选确认。
34 changes: 34 additions & 0 deletions docs/wiki/pages/Coding-Workspace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
[English] | [简体中文](编程工作台) · [Home](Home)

# Coding workspace

## From a request to an inspectable change

1. Open the correct project and check whether it is local, SSH, container, WSL, or peer-owned.
2. Ask the Agent to inspect the relevant code and explain its findings. For planning-only work, explicitly prohibit edits.
3. Review the approach, then authorize implementation within the intended scope.
4. Run the project's checks and inspect diffs and unresolved failures.
5. Review changes before committing, pushing, or publishing.

Use [Harness selection](Agent-Modes) for the execution approach. Debugging, planning, research, and review do not require the old mode buttons described in earlier guides.

## Integrated tools

- Files and editor: browse and organize material, search, edit code/text, view Markdown/images and diffs, and use available language services or inline AI.
- Terminal: run commands, use multiple terminal views, and inspect background processes.
- Git: inspect changes, history, branches, and worktrees; stage, commit, push, or pull with the appropriate authorization.
- Browser: inspect pages, follow supported interactions, and collect visual evidence.
- Review: ask for actionable findings or use the available review workflow. Read-only review must not silently implement fixes.
- Sessions: preserve separate conversations, inspect modified files, and manage history; see [sessions](Sessions-and-Goals).

Language intelligence and browser/computer actions depend on configured services and OS permissions. A successful command does not prove the resulting application works.

## Recovery is not a blanket backup

Session forks copy conversation history, not an independent filesystem. Snapshot and rollback capabilities depend on recorded coverage and target support; they are not protection for every command or external side effect.

For remote sessions, full file rollback and edit-and-rerun are currently unavailable until coverage can be verified. Some recorded operations can still show diffs after disconnect. Use Git commits and backups for recovery; do not assume a conversation fork isolates work.

[Remote guide](Remote-and-Multi-device) · [CLI reference](https://github.com/GCWing/OpenBitFun/blob/v1.0.0/src/apps/cli/README.md)

> Screenshot pending: S08 — editor, terminal, and session; S09 — Git changes and review.
37 changes: 37 additions & 0 deletions docs/wiki/pages/Cowork-and-Creation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
[English] | [简体中文](Cowork-与创作) · [Home](Home)

# Research, office work, and creation

This page keeps its old address for existing links. The workflows below do not require a separate Cowork mode.

## Work from an outcome

Give the Agent the source material, intended audience, desired format, and success criteria. Choose a [Harness](Agent-Modes) for the task's complexity, and ensure the relevant Skills, tools, model, and dependencies are available.

Examples:

- “Research this topic, compare sources, and write a referenced brief.”
- “Turn these notes into an editable slide deck.”
- “Analyze this workbook; preserve the original and explain the formulas.”
- “Create a PDF guide and inspect its rendered pages.”

## Deliverables and verification

| Work | What to check before delivery |
| --- | --- |
| Documents | Claims, hierarchy, references, and rendered layout |
| Presentations | Story, slide layout, editable export, and fonts |
| Spreadsheets | Formulas, units, source data, and recalculated results |
| PDFs | Page rendering, clipping, text, and pagination |
| Research | Source dates, primary evidence, conflicting claims, and uncertainty |
| Visual explanations | Accurate data, readable labels, and useful interactions |

Artifact generation depends on the installed Skills and execution environment. If a dependency or export path is unavailable, resolve it or use an explicit alternative rather than presenting an unsupported format as completed.

## Iterate in the same workspace

Ask the Agent to revise the actual saved artifact, not just describe a hypothetical change. Preserve source files and inspect the new output. Interactive explanations can remain in the conversation, become a [Mini App](Mini-Apps-and-Pages), or be saved and published as a Page.

Browser and desktop interactions require supported tools and permissions. Purchases, messages, deletion, and publication need explicit intent and review.

> Screenshot pending: S10 — generated artifact with preview; S11 — interactive visual explanation.
Loading