-
apsis-book 0.1.0 Stable
released this
2026-10-02 15:23:38 +08:00 | 0 commits to main since this release================
The documentation and tool service of ApsisRS, which presents the computational kernels for commercial spaceflight and satellite internet in a browser. Every asset it serves is embedded in the binary, so a release is one file with no dependency other than the C library.
ApsisRS 的文档与工具服务,在浏览器中呈现面向商业航天与卫星互联网的计算内核。它所服务的每一项资源都内嵌在二进制里,因此一次发布就是一个文件,除 C 库外没有依赖。
Scope / 范围
One binary serves four kinds of content, and the frontend that presents them:
/api/docs concept documents, the knowledge graph, the search index /api/graph the concept graph, the crate structure, the algorithm flows /api/api the interface of apsis-rs, extracted from its doc comments /api/tools nine tools that run the kernels on parameters you supply / the frontend, which is the same single page for every route一个二进制提供四类内容,以及呈现它们的前端。
/api/docs 概念文档、知识图谱、搜索索引 /api/graph 概念图谱、crate 结构、算法流程图 /api/api apsis-rs 的接口,从其文档注释提取 /api/tools 九个工具,在你给定的参数上运行内核 / 前端,每条路由共用同一个单页The content is a superset of what any one library implements: thirty-one documents in English and Chinese, a graph of thirty-seven concepts and four algorithm flows, and the interface catalogue of forty crates and twelve hundred and two items. That catalogue is generated from the library's source rather than maintained by hand, so it cannot describe an interface the library no longer has.
内容大于任何一个库所实现的范围:三十一篇中英双语文档,含三十七个概念与四张流程图的图谱,以及四十个 crate、一千二百零二个项的接口目录。该目录由库的源码生成而非手工维护,因此不会描述一个库已不再拥有的接口。
Highlights / 本次要点
-
A release build is a single self-contained binary of about two megabytes. The HTTP server, the JSON codec, the Markdown renderer and the formula renderer are all written against the standard library, because the project allows one dependency: the library whose interface it documents.
发布构建是一个约两兆字节的自包含二进制。HTTP 服务器、JSON 编解码器、Markdown 渲染器与公式渲染器全部基于标准库编写,因为本项目只允许一个依赖——它所记录接口的那个库。
-
A formula is written the way Markdown writes one, between dollar signs, and translated to MathML. The browser lays it out and prints it, so no script has to run for a formula to appear, and what a reader copies is the notation it was written in rather than one character per line.
公式按 Markdown 的写法书写,写在美元符号之间,并翻译为 MathML。浏览器自行排版与打印,因此公式出现不需要运行任何脚本;读者复制得到的是公式书写时的记法,而不是每行一个字符。
-
Every document is written in English and translated into Chinese, and so is every doc comment in the source. The interface opens in Chinese and switches to English from the top bar.
每篇文档都以英文撰写并译为中文,源码中的每条文档注释也是如此。界面以中文打开,可在顶栏切换到英文。
-
Quality gates: cargo fmt --check, cargo clippy --all-targets with no warning, 152 tests across 23 targets, cargo doc with no warning, svelte-check with no error, and a render audit that opens all ninety-three routes in both languages, both themes and two widths — seven hundred and forty-four pages, each checked for a page that does not load, a page with almost no text, a page that scrolls sideways, or a formula that loses a character.
质量门禁:格式检查、clippy 零告警、23 个目标共 152 个测试、cargo doc 无警告、svelte-check 无错误,以及一项渲染审计——在两种语言、两种主题与两种宽度下打开全部九十三条路由,共七百四十四页,逐页检查页面未加载、正文近乎空白、横向溢出,或公式丢字符。
Notes / 说明
-
The service is deployed at https://apsis.focus1024.com/. What is deployed is not merely similar to a build from this source: because every asset is inside the binary, it is the same service.
服务部署在 https://apsis.focus1024.com/。所部署的并非「与由本源码构建出的东西相似」——由于每一项资源都在二进制里,它就是同一个服务。
-
There is no test code in
src/. Every test is intests/, as the library's tests are, and the few internal items a test reaches are opened through one module named for that purpose.src/中没有测试代码。所有测试都在tests/,与库的做法一致;测试所需的那少数内部条目经一个为此命名的模块开放。 -
A release image is provided, with the build in three stages and a compose file beside it. The image carries the binary and nothing else, on the same reasoning as the binary carrying everything else.
提供发布镜像,构建分三个阶段,旁边有 compose 文件。镜像只携带二进制,别无其他——理由与二进制携带其余一切相同。
-
Licence: GPL-3.0-or-later, and that alone. The library this service documents is offered under MIT or Apache-2.0; both permit redistribution inside a GPL work, so the two are distributed together under these terms.
许可协议:GPL-3.0-or-later,且仅此一种。本服务所记录的库以 MIT 或 Apache-2.0 提供;两者都允许在 GPL 作品内再分发,因此二者按本协议一并分发。
Downloads
-