docs: English-first public/adoption surface (Japanese versions kept) - #5
Merged
Conversation
…ions kept) Global adoption needs English-first docs. This converts everything an adopter reads: - All public rustdoc + inline comments in core/src (lib, system, ask, net, metrics, pinning, mpsc, spsc, sync) → English. No code changed (comments/doc-strings + a few test assert messages only). Doctests and Loom pass. - All 10 examples → English comments (hello_actor, request_reply, sharded, supervision, pubsub, tokio_interop, echo_server, io_bench, echo_glommio, matching_engine). - docs/guide.md → English; docs/guide.ja.md keeps the Japanese version (cross-linked). - README.ja.md added; README.md cross-linked. Language switch at the top of both guide and README. - Doc-accuracy fix: removed ask_timeout references (that API lives on an unmerged branch; not in main). Adopter-facing surface (rustdoc/examples/guide/README) is now English-first with Japanese kept. Deep design docs (design.md, io-surface-design.md, etc.) remain a follow-up phase. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
Global adoption needs English-first docs. This converts everything an adopter reads to English, while keeping Japanese versions of the guide and README.
Converted to English
core/src(lib, system, ask, net, metrics, pinning, mpsc, spsc, sync). Comments/doc-strings only — no code logic changed. Doctests (3) and Loom (5) pass.docs/guide.md→ English;docs/guide.ja.mdkeeps the Japanese version (cross-linked at the top).README.ja.mdadded;README.mdcross-linked.Doc-accuracy fix
ask_timeoutreferences from the guide/example — that API lives on an unmerged branch and is not inmain(documented a non-existent API). Merging that branch is a worthwhile follow-up (it closes theaskliveness weakness, Miri-verified).Scope
Adopter-facing surface (rustdoc / examples / guide / README) is English-first. Deep design/thesis docs (
design.md,io-surface-design.md,competitive-landscape.md, …) remain Japanese and are a follow-up phase.Verified: build (default + net), tests, doctests, clippy, and Loom all green; no Japanese remains in
core/srcorcore/examples.🤖 Generated with Claude Code