#4789·redux

[文档] 考虑将所有文档合并到一个统一的文档网站

作者: markerikson创建于 2025年4月23日更新于 2026年3月18日
标签Documentation

□ 背景情况

https://GitHub.com/reduxjs/redux-toolkit/issues/2637#issuescomment-1229091424复制我的评论(在https://www.reddit.com/r/reduxjs/comments/1e4r3ts/the worst documentation ever/中也有类似的想法):

出于非常有效的历史原因,我们有三个独立的图书馆,每个图书馆都有自己的复存:

因此,我们也有三个不同的文件网站:

  • https://redux.js.org:Redux Docs原始网站. 是否有主要教程, 用于“ redux” 的 API 文件, 以及“ 写测试”、“ 使用thunks/ selectors ” 、 “ 组织削减器” 等内容的一般使用指南 。
  • https://react-redux.js.org:React-Redux文件。 这些原本只是Markdown在repo的文件——我们直到2018年才作为实际的docs站点设置. 关于使用 " 连接 " 的陈旧教程、用于钩和 " 连接 " 的API文件,以及关于使用 " 连接 " 的几种使用指南。
  • https://redux-toolkit.js.org:Redux工具包文件。 拥有用于RTK和RTK查询的大量API文件,以及RTK和RTKQ的使用指南

(也可以包括Reselect,

这些文件的每个网站都是根据各自内容建立的。

RTK的docs did 在2019年有一套"基础/中间/高级"的教程页面. 然而,当我在2020年重写了Redux核心的docs教程时,我意识到新的教程(A)要好得多,而B)重复了教程内容是令人困惑的.

因此,我确定的方法是,所有实际的“教义”内容都将与通用使用指南(测试、tunks/selectors等)一起进入核心文献网站。

API 文件和特定图书馆的用法指南将保留在单独的Repos/docs网站。

我考虑过把文件合并成一个大网站的想法 这样做可能有一些好处,包括只有 一个地方可以找到东西。

{\fn黑体\fs22\bord1\shad0\3aHBE\4aH00\fscx67\fscy66\2cHFFFFFF\3cH808080}别这样

为了做到这一点,我们几乎必须把所有三个 library 合并成一个合并的单列波.

这将会是一个巨大的任务。 我们必须: