Contribute

Found something wrong or hard to follow? Use Report an issue at the foot of the affected chapter. The link includes the chapter title and public URL, so the report starts with the right location. If the correction is already clear, use Edit this page beside it. GitHub opens the source .qmd file and guides the change into a pull request.

The source repository contains the English and Chinese text, bibliography entries, figure sources, reader, build pipeline, and server. Reports are welcome in English or Chinese. A report is useful even when it identifies a gap without supplying the final wording or implementation.

What helps most

• A factual correction. State the claim that is wrong and provide a primary source when one is available. A research paper, official specification, regulator publication, product documentation, or release note is stronger evidence than a summary that cites none of them.
• A stale number or name. Prices, context limits, benchmark results, model names, laws, and product behavior need a publication or release date. Include the date and scope in which the replacement value is valid.
• An unclear passage. Identify the point where the explanation stops following. The problem may be a missing definition, an unstated assumption, a jump between layers, an equation whose symbols are not defined, or an example that does not support the claim around it.
• A presentation or implementation fault. Typos, a broken link, math that does not render, a clipped diagram, inaccessible controls, mobile overflow, and defects in the reader, build, or tooling are all in scope.
• A disagreement between editions. English and Chinese should preserve the same technical claim, same chapter structure, sources, equations, and figure meaning. They are not sentence-for-sentence copies: each edition should read naturally in its own language.

A useful report includes enough detail to reproduce the problem:

1. the page title and section heading;
2. the exact sentence, equation, figure, link, or interaction;
3. what is wrong or unclear;
4. what should replace it, if known;
5. the primary source and its publication or release date for a factual correction;
6. browser, viewport, or error output for a rendering or reader defect.

If the issue concerns a live or fast-changing claim, distinguish the date of the source from the date on which it was accessed. A current web page may have changed since the chapter cited it. If two credible sources disagree, include both rather than presenting one as settled.

Sending a change

For a small correction, Edit this page opens the exact source file in GitHub's editor. Make the smallest change that fixes the reported problem, describe the before-and-after meaning in the pull request, and link the evidence. Do not edit _book/; it is generated by the build.

For a larger change, read the repository's contributing guide. It documents the source layout, local tools, and build commands. Preserve stable headings, section identifiers, cross-references, citation keys, figure identifiers, and runnable interfaces unless the change specifically requires a migration.

Content changes must update both language trees. That requirement concerns technical parity, not literal translation: preserve the same claim, evidence, structure, equations, and examples while writing idiomatic English and Chinese. If only one language can be corrected, open an issue with the evidence instead of copying text mechanically into the other edition.

Before requesting review, run the relevant local checks from the contributing guide. The continuous-integration workflow runs lint, builds both language editions, then runs the Bun content and reader tests and the Go routing tests. A change is not ready when one language fails to compile, an internal link no longer resolves, a citation loses its bibliography entry, or a stable reader route changes without a redirect and regression test.

License and contribution scope

The published content uses CC BY-NC-ND 4.0. That public license allows noncommercial sharing with attribution but does not permit sharing adapted versions. It does not prevent the copyright holder from maintaining the canonical edition in this repository.

For incoming changes, repository policy welcomes corrections, clarifications, and repairs. It does not accept unsolicited rewrites that merely substitute a different voice without identifying a factual, explanatory, structural, accessibility, or rendering problem. If a proposed change is broader than that boundary, open an issue first and describe the reader problem it is intended to solve.