Documentation index

Start with the bilingual root READMEs (English / 简体中文). This index routes detailed operation, security, migration, contribution, release, and acceptance documents by role.

Reading paths

You are…	Read in this order
New user evaluating skillferry	README → PORTABILITY_CONTRACT → COMPARISON
Security reviewer / cautious user	THREAT_MODEL → SECURITY.md → the acceptance records
Contributor / adapter author	CONTRIBUTING.md → AGENT_MATRIX → acceptance/

Documents

Document	Contents
PORTABILITY_CONTRACT.md	What the five grades promise, overlay merge order, ownership/conflict rules, secret handling, exit codes
THREAT_MODEL.md	Assets and trust boundaries, the nine refused threats, acknowledged v1 limits, out of scope
AGENT_MATRIX.md	Per-target loading paths (where each asset lands) and the evidence behind every grade
COMPARISON.md	Measured landscape comparison; what we can and cannot claim about competitors
acceptance/release-0.1.0.md	Release identity, gate results, publication readback, and evidence boundaries
acceptance/macos-native.md	Evidence record: full rehearsal on a real macOS machine
acceptance/windows-native.md	Evidence record: full rehearsal on a real Windows machine
acceptance/zero-change-codex-sync.md	Proof that building skillferry never mutated the legacy codex-sync repo

The acceptance records are intentionally English-only: they are timestamped command transcripts and machine evidence, not prose to translate.

Chinese translations

The core documents have Chinese translations in zh-CN/; the root entry point is README.zh-CN.md, with release history in CHANGELOG.zh-CN.md.