#193·recompose

新文档

作者: acdlite创建于 2016年6月9日更新于 2021年2月1日
标签help wantedgood first issue

我建议以下步骤:

  • 使用 ESDoc 来文档化 API 并生成一个文档网站。documentation.js 也被考虑过,但我非常喜欢 ESDoc 网站的用户体验。例如,请查看 RxJS 的新文档。
  • 重写 README/Introduction 以更好地定位库,首先和最重要地,它是一个用于 React 组件的函数式实用程序库 — 不是 一个状态管理库,也不是一个完全替代类组件或整个应用程序架构。
  • 文档讨论组件与高阶组件以及带有额外参数的高阶组件(我们一直称之为"辅助函数",但更好的名称是可取的)。
  • 文档关于性能,可能包含一个关于组件压缩的部分。
  • 文档关于最佳实践和陷阱(如何不要使用库)。此文档应讨论将多个高阶组件组合成一个 enhance HOC,然后将其应用于基础组件的首选模式。

内容来源: acdlite/recompose