ApsisRS
/
apsis-rs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
apsis-rs/docs/design
History
ApsisRS contributors 73731ad5d0 docs: add the bilingual glossary 
The bilingual documentation convention needs a rule for terms, otherwise the
same word gets translated two ways in two files. The glossary separates the
terms that keep their English form, being proper names, abbreviations and
methods that exist only in English in the source literature, from the terms
that have a standard Chinese name and use it directly. It also fixes how a
formula is written, since a formula in a comment has to agree with the code
it describes.

Both languages are written, as the convention requires.
 		2026-10-02 00:13:34 +08:00
..
README.md docs: add the bilingual glossary 2026-10-02 00:13:34 +08:00
README.zh.md docs: add the bilingual glossary 2026-10-02 00:13:34 +08:00
errors.md docs: give every note an English and a Chinese version 2026-09-30 19:23:26 +08:00
errors.zh.md docs: give every note an English and a Chinese version 2026-09-30 19:23:26 +08:00
glossary.md docs: add the bilingual glossary 2026-10-02 00:13:34 +08:00
glossary.zh.md docs: add the bilingual glossary 2026-10-02 00:13:34 +08:00
layers.md docs: give every note an English and a Chinese version 2026-09-30 19:23:26 +08:00
layers.zh.md docs: give every note an English and a Chinese version 2026-09-30 19:23:26 +08:00
parallel.md docs: give every note an English and a Chinese version 2026-09-30 19:23:26 +08:00
parallel.zh.md docs: give every note an English and a Chinese version 2026-09-30 19:23:26 +08:00
sim.md docs: give every note an English and a Chinese version 2026-09-30 19:23:26 +08:00
sim.zh.md docs: give every note an English and a Chinese version 2026-09-30 19:23:26 +08:00
units.md docs: give every note an English and a Chinese version 2026-09-30 19:23:26 +08:00
units.zh.md docs: give every note an English and a Chinese version 2026-09-30 19:23:26 +08:00

README.md

Design notes

English | 简体中文

This directory records the cross-crate design decisions of ApsisRS, such as the coordinate and unit conventions, the error and tolerance strategy, the layer boundaries and the parallelism. The design inside a single crate is documented in that crate's module documentation.

A note is self-contained and refers only to code in this repository or to a public standard.

Cross-layer conventions

Per-layer design