[[about-doc]]
= 关于文档
:linkattrs:
本节是对 Reactor 参考文档的简要概述.你并不需要从头到尾阅读该文档.每一节的内容都是独立的,不过会有其他章节的链接.

== 最新版本 & 版权说明

本 Reactor 参考文档也提供 HTML 形式.最新版本见 `http://projectreactor.io/docs/core/release/reference/docs/index.html`.

本文档的副本你可以自用,亦可分发给他人.不过无论是打印版还是电子版,请免费提供.

本文档的大多数翻译来源于 https://github.com/get-set/reactor-core/tree/master-zh/src/docs[https://github.com/get-set/reactor-core/tree/master-zh/src/docs]

== 贡献本文档

本参考文档用 https://asciidoctor.org/docs/asciidoc-writers-guide/[Asciidoc] 编写, 其源码见 https://github.com/reactor/reactor-core/tree/main/docs/asciidoc

如有任何补充,欢迎你提交 pull request.

我们建议你将源码 checkout 到本地,这样可以使用 gradle 的 `asciidoctor` 任务检查文档渲染效果. 有些章节会包含其他文件,Github 并不一定能够渲染出来.

ifeval::["{backend}" == "spring-html"]
TIP: 为了方便读者的反馈,多数章节在结尾都提供一个链接,这个链接可以打开一个 Github 上的 编辑界面,从而可以编辑相应章节的源码.这些链接在 HTML5 的版本中能够看到,就像这样:  link:https://github.com/reactor/reactor-core/edit/main/docs/asciidoc/aboutDoc.adoc[Suggest Edit^, role="fa fa-edit"] - <<about-doc>>.
endif::[]

== Getting Help
Reactor 项目有多种方式希望能帮助到你:

* 与社区沟通:  https://gitter.im/reactor/reactor[Gitter].
* 在 stackoverflow.com 的 https://stackoverflow.com/tags/project-reactor[`project-reactor`] 进行提问.
* 在 Github issues 提交 bug .下边这几个库我们会一直关注: https://github.com/reactor/reactor-core/issues[reactor-core] (涉及 Reactor 的核心功能) 以及 https://github.com/reactor/reactor-addons/issues[reactor-addons] (涉及 reactor-test 和 adapters issues).

NOTE: 所有 Reactor 项目都是开源的, 包括 https://github.com/reactor/reactor-core/tree/main/docs/asciidoc[本文档]. 如果你发现本文档有问题,或希望补充一些内容,请参考 https://github.com/reactor/.github/blob/main/CONTRIBUTING.md[这里] 进行了解.

== 如何开始阅读本文档
* 如果你想直接写代码请参考 <<getting-started>>
* 如果你对 响应式编程(Reactive Programming) 比较陌生,最好从 <<intro-reactive,响应式编程>> 开始.
* 如果你对 Reactor 的理念比较熟悉,只是在编写程序时查找合适的操作符, 请参考附录 <<which-operator,我需要哪个操作符 ? >> .
* 如果你想深入了解 Reactor 的核心功能,请参考 <<core-features,Reactor 核心特性>>,以便了解:
** 关于 Reactor 的响应式类型 <<flux>> 和 <<mono>> 章节.
** 如何调整执行的线程环境 <<schedulers, scheduler>>.
** 如何处理问题 <<error.handling>> .
* 单测的内容主要来自  `reactor-test` 项目,参考 <<testing>>.
* <<producing>> 提供了更加丰富的创建响应式源(reactive source)的方式.
* 其他高级主题请看参考 <<advanced>>.
