docs: refresh bilingual MCP integration guides and site usability - #56
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem and result
The guides still described implemented UDS/Linux/Codex execution paths as future work, while startup examples omitted workspace registration and helper configuration. Readers could also mistake EOF for command success, a Compose sleeper for a Runner, or test-source coverage for a completed validation run.
This PR rewrites the 15 maintained English/Korean pairs, adds an Agent Loop integration pair, and makes the site lead through setup → MCP connection → read/patch/exec → result inspection. English remains the editorial source; Korean was reviewed as prose, including tables, recovery instructions, and locale links. Irrelevant CoS/cokacremote comparisons and unexplained work-package notes are removed; dependency and license attribution is retained.
Scope: documentation, example comments, site wording/generation, and focused documentation tests. No MCP DTO, runtime, policy, persistence, dependency, release, or deployment behavior changes. Leave unmerged for user review; no Pages deployment is requested.
Review ledger
Each row covers both language files (unless noted). “Source review” is static evidence, not a claim of live deployment.
indexoperationsagent-integration(new)architectureexecution-substraterunner-isolationsecurity-modelbehavior-differencesrunner/src/apply.rsand gateway operation records → state table and post-apply verification caveaterror-codesprotocol-compatibilityprotocol_compatsource review; stdio initializationchatgpt-connectorcodex-reuseupstream-lockupstream-updatedocumentation.env.example, workspace exampleBefore / after examples
All existing document routes remain. 198 legacy rendered heading anchors were checked across the 30 pre-existing pages, including VitePress's decomposed Korean IDs; GitHub-style anchors are preserved too. New routes:
/guide/agent-integrationand/ko/guide/agent-integration.Validation
Head:
1f3bbe8fa917319005c06f2f3a700afadd70e890(three reviewable commits). Base main:ab5defb620a41e4239320dd80827d4f947a61adb; remote main rechecked before submission.python3 -B scripts/check_docs.py: 16 reviewed pairs.npm ci --prefix docs-site --ignore-scripts: passed with pinned Node 24.21.0/npm 11.19.0.npm test --prefix docs-site: 5/5 passed, including explicit/fenced anchors, purposeful locale home cards, and Korean link remapping.npm run build --prefix docs-siteandpython3 -B docs-site/scripts/site.py check: passed, 35 HTML pages; full local link/fragment/resource/copy-hash inventory.DEVELOPER_DIR=/Library/Developer/CommandLineTools, Rust 1.98.0). Default Xcode selection initially failed because its license was unaccepted; no license or machine setting was changed.http_contract(2/2) andprotocol_compat(7/7) also passed, including forced-version stdio/HTTP cases. Release-profile builds and UDS live smoke were not repeated locally; hosted CI remains separate.docs-pageswas skipped as intended. Download the rendered review artifact.b580cefa3b0016562289bf10c79b4cf2410011ea, whose parents are the unchanged base and exact head above. The full Git tree matches HEAD (e1f208c9daef586296c0aa397c80f65ce62e4987), and all 32 source hashes match the clean local HEAD build. This is a PR preview commit, not an actual merge into main.rustaggregate. Together with docs-build, 15 checks passed; only docs-pages was intentionally skipped. Final HEAD is unchanged and main was rechecked atab5defb620a41e4239320dd80827d4f947a61adb. Ready for user review; do not merge or deploy as part of this task.For the rendering comparison, the currently published home is the unchanged pre-PR baseline (observed at base
ab5defb); the linked review artifact contains the rewritten home and guides. The before/after table above describes the visible differences. To reproduce the after view locally, check out the exact head and use the documented build/static-preview commands. Rebuilding requires stopping and restarting the verified preview, which pins the manifest at startup.The PR workflow's documentation artifact is a review build, not a deployed public website. Published Pages is deliberately unchanged.
Runtime follow-up, not fixed here
crates/runner/src/apply.rscallsverify_disk_matches_claimed(...).await?after a successful helper response; snapshot restoration is only in the helper-error branch. The gateway can consequently recordrejectedafter files changed. The guides now explicitly require inspection after post-apply verification errors. A separate runtime change should define the rollback/result contract and fault-injection coverage.Other existing integration limits remain explicit: no public process exit code or output-loss flag; one live mutation/command per workspace; bounded file reads/find without paging; no durable process handles; no container dispatch or OAuth server. Restricted mode without a usable Linux helper can execute on the host with no OS network enforcement; enabled mode requires the helper.