docs: sync to v0.5.0 reality#12
Merged
Merged
Conversation
The docs were lagging the code. Most issues fall into three groups:
1. The new ch4p gui desktop app (apps/gui, shipped in v0.5.0) was
undocumented. Added a row to the README "Three modes" table
(now four), a Where-to-Start blurb in docs/index.md, and a new
"GUI app" paragraph in docs/explanation/architecture.md so the
six-layer stack reflects all three surfaces.
2. Stale version strings from when the project was on 0.1.x:
- docs/reference/cli.md had "Version 0.1.0" in the status output
example.
- docs/tutorials/getting-started.md had "ch4p v0.1.3" in two
example outputs.
3. Stale channel counts from when there were 14 channels:
- docs/reference/cli.md, docs/tutorials/getting-started.md, and
both explanation docs (concurrency.md, security-model.md) all
said "14" or "14+" -- now 16. The getting-started enumeration
was also missing Zalo Personal, macOS Native, and the local
CLI; it now lists all 16.
Plus a few internal-consistency fixes:
- README.md test count line said "91 test files, 2642 tests"; the
badge directly above already said 2711. Both now say
"102 test files, 2711 tests" (the file count was also stale).
- CONTRIBUTING.md required Node >= 22 but package.json engines say
>= 20.0.0. Lowered to 20 to match.
- CONTRIBUTING.md test command comment said "(2 449+)"; now (2711+).
- SECURITY.md "Supported versions" table only listed 0.1.x.
Now lists 0.5.x as supported and explicitly marks <0.5 as not
supported, with a sentence explaining the policy (latest minor
only).
False positives caught during the audit (left as-is):
- "claude-sonnet-4-6" in docs/how-to/use-routing.md is the correct
current model id (see packages/providers/src/anthropic.ts:49),
not a typo.
vxcozy
added a commit
that referenced
this pull request
Apr 11, 2026
When a CLI subprocess exits before the parent finishes writing the prompt (e.g. argument validation fails on launch), Node emits an EPIPE error event on child.stdin. Without a listener, that error bubbles as an uncaught exception and crashes whatever process owns the engine — Vitest in CI, the gateway in production, or the agent loop interactively. The exit code path that already runs after the subprocess closes is the source of truth for failure reporting, so silently dropping EPIPE on the stdin stream is safe. Other error codes are surfaced as a text_delta so they don't disappear silently. Surfaced as an uncaught error in the subprocess.test.ts run on PR #12 CI: all 2711 tests passed but the runner exited 1.
5 tasks
vxcozy
added a commit
that referenced
this pull request
Apr 11, 2026
…#13) When a CLI subprocess exits before the parent finishes writing the prompt (e.g. argument validation fails on launch), Node emits an EPIPE error event on child.stdin. Without a listener, that error bubbles as an uncaught exception and crashes whatever process owns the engine — Vitest in CI, the gateway in production, or the agent loop interactively. The exit code path that already runs after the subprocess closes is the source of truth for failure reporting, so silently dropping EPIPE on the stdin stream is safe. Other error codes are surfaced as a text_delta so they don't disappear silently. Surfaced as an uncaught error in the subprocess.test.ts run on PR #12 CI: all 2711 tests passed but the runner exited 1.
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
1 participant
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.
Summary
Three-part audit of all documentation in this repo and our ch4p-docs site, applying every fix here. The companion docs-site PR is ch4p-labs/ch4p-docs#1.
What was wrong (grouped by root cause)
1. The new `ch4p gui` desktop app was undocumented
`apps/gui` shipped in v0.5.0 but never made it into the README, the docs index, or the architecture explanation.
2. Stale version strings (0.1.x era)
3. Stale channel counts (14 → 16)
4. Internal inconsistencies
Audit false positives (verified, left as-is)
Test plan