Document finishing / 文档整理

[hzgotb]

我正在使用这个库开发app，在文档不齐全的时候只能去找demo，然后结合自己的理解去开发。深深感觉到文档对一个开源库的重要性。

我可以为这个项目贡献一部分时间。

希望能pr一个新分支作为文档的开发分支。

[chenxianqi]

你可以fork 然后 发PR呢

[hzgotb]

我在征求意见，也怕别人也有在做。冲突到了，而且看看@zjuwjf 对这个有没有什么要求。

[zjuwjf]

fish-redux非常需要社区同学的帮助，我们欢迎任何形式的有意义的贡献。

要求是，新的文档比现在的要更好 -，-。

[hzgotb]

中文文档
English version

2019.7.２５ 更新了中文版本

[zjuwjf]

非常感谢，@hzgotb 对文档建设，牵起来一个不错的开始。

建议后续我们可以就文档相关／常见问题等，集中汇集于此。

[hzgotb]

• 整理每个库向外暴露的类，及其方法。
• 整理一些浅而易懂的例子
• 其它

长期目标： 补全下方目录，欢迎讨论。

---

使用

• 介绍
• 演变史
• 通信机制
• 其它
  • 兼容性
  • 更新日志
• 入门
  • 安装
  • 写一个页面
  • 写一个组件
  • 复合组件
  • 写一个中间件
• 进阶
  • Auto Dispose
  • Filter
  • Higher Effect
  • OnError
  • 面对对象写法
  • ShouldUpdate
  • WidgetWrapper

概念

• 连接器（Connectors）
• 组件（Components）
• 适配器（Adapters）
• 路由（Routes）
• 中间件（middlewares）
• 切面（AOP)
• 页面 (Page)
• 生命周期（Lifecycle）

其它

• 和 Redux 的区别

库

redux
redux_connector
redux_component
redux_adapter
redux_routes
redux_middleware
redux_aop

[zjuwjf]

@hzgotb 是不是可以里一个大致的提纲，然后拆解

1. 入门指南
     a) 安装
     b)  一个page的开始
     c)  一个component的编写
           e）一个reducer的编写
           f)   一个effect的编写
           g)  一个action的发送
     d)  一个connector的编写
     h）一个middleware的编写 

2. 概念和类介绍
  可以根据src目录下的结构来
   a) redux
   b) redux_connector
   c) redux_component
   d) redux_adapter
   e) redux_routes
   f) redux_middleware
   g) redux_aop

3. 常见问题
  汇总目前issue中常见的问题和解决方案

[hzgotb]

修改了上面的。我先把现有的更新一下，然后做一个新分支的PR过来。预计周末完成。

[hzgotb]

@zjuwjf 烦请新建一个名为 site-www 的分支。

[zjuwjf]

OK了

[hzgotb]

示例记录：

• Page-Store可以订阅任意其他store的变化的使用[0.1.8]
  note: #230里的bindObserver已换成addObservable。看请问appState的模式下，监听路由跳转的RouteAction.route会在什么时候执行？ #264
• 路由以及传参[0.1.5] 关于fish-redux支持 App级别Store的讨论 #153 通过路由传递的参数，怎么接收 #78
• keepalive Page view切换页面后状态丟失，如何解决 #272
• 使用 MapLike page和component关系 #240
• unsubscribe store changes in dispose Question: How can I unsubscribe store changes in dispose #315
• RefreshIndicator usage reconstruct mixed-store #209 - dispatch can return value by effect

[FreeTimeWorker]

期待更详细文档。

[Lizhooh]

这文档，没谁了，连最基本的 get start 都没有。

[FreeTimeWorker]

建议通过渐进式的方式来介绍各部分的功能用法
比如 reducer 和action肯定是有关系的，先写一个最基础的写法，然后在这个基础上，加上effect ，让effact和reduer都可以工作的情况下，介绍他两个的区别，然后介绍 关于effect中副作用具体指那些
Lifecycle {
initState,
didChangeDependencies,
build,

reassemble,

didUpdateWidget,
deactivate,
dispose,

//adapter
appear,
disappear,
}
枚举中的 这些状态分别表示什么
紧接着 再说dependencies 与viewservice中的用法以及connect，一步一步的 在一份代码上写出example中那种效果，最后再说高级用法，如何在一个应用程序中通过这种方式来做到主题的统一与修改。往采纳，现在看了半天也刚做出来一个页面中的状态同步，后边的实在是看不下去了

[hzgotb]

这文档，没谁了，连最基本的 get start 都没有。

已经在赶了。到时demo和入门一起出。

[hzgotb]

建议通过渐进式的方式来介绍各部分的功能用法
比如 reducer 和action肯定是有关系的，先写一个最基础的写法，然后在这个基础上，加上effect ，让effact和reduer都可以工作的情况下，介绍他两个的区别，然后介绍 关于effect中副作用具体指那些
Lifecycle {
initState,
didChangeDependencies,
build,

reassemble,

didUpdateWidget,
deactivate,
dispose,

//adapter
appear,
disappear,
}
枚举中的 这些状态分别表示什么
紧接着 再说dependencies 与viewservice中的用法以及connect，一步一步的 在一份代码上写出example中那种效果，最后再说高级用法，如何在一个应用程序中通过这种方式来做到主题的统一与修改。往采纳，现在看了半天也刚做出来一个页面中的状态同步，后边的实在是看不下去了

前期会简单的说明怎么时候，进阶的会说一些概念的东西。欢迎PR。

[FreeTimeWorker]

等待中，，实力有限，初学实在是看不懂，想帮忙也一点都帮不上，加油！！

…

------------------ 原始邮件 ------------------ 发件人: "hzGotB"<[email protected]>; 发送时间: 2019年6月21日(星期五) 晚上11:00 收件人: "alibaba/fish-redux"<[email protected]>; 抄送: "阿山"<[email protected]>; "Comment"<[email protected]>; 主题: Re: [alibaba/fish-redux] Document finishing / 文档整理 (#252) 建议通过渐进式的方式来介绍各部分的功能用法 比如 reducer 和action肯定是有关系的，先写一个最基础的写法，然后在这个基础上，加上effect ，让effact和reduer都可以工作的情况下，介绍他两个的区别，然后介绍 关于effect中副作用具体指那些 Lifecycle { initState, didChangeDependencies, build, reassemble, didUpdateWidget, deactivate, dispose, //adapter appear, disappear, } 枚举中的 这些状态分别表示什么 紧接着 再说dependencies 与viewservice中的用法以及connect，一步一步的 在一份代码上写出example中那种效果，最后再说高级用法，如何在一个应用程序中通过这种方式来做到主题的统一与修改。往采纳，现在看了半天也刚做出来一个页面中的状态同步，后边的实在是看不下去了 前期会简单的说明怎么时候，进价的会说一些概念的东西。欢迎PR。 — You are receiving this because you commented. Reply to this email directly, view it on GitHub, or mute the thread.

[tianlinzx]

example最好也稍微详细是说明一下，感觉用了很多晦涩的API，不解释看不懂，只能copy paste。

[Beats0]

这example来点注释可好, 只能自己慢慢推测 = =

[toeii]

example最好也稍微详细是说明一下，感觉用了很多晦涩的API，不解释看不懂，只能copy paste。

我也是有相同的感受，现在默默的切回了provide

[tianlinzx]

能否也把example示例丰富一下，示例里面还有好多//todo，没有注释也不知道具体用法。

[summer789]

这个 example 也是没谁了，一看就劝退

[zjuwjf]

@summer789 @tianlinzx @toeii @Beats0 非常抱歉，之前的example的注释不足。

#393 添加了注释。

[tianlinzx]

看到这次周末更新了，很给力，代码注释基本上都有了。感谢。@zjuwjf

[pengdongliang]

希望尽快出个官方的文档, 好多类都不知道是做什么的, 另外还很多没见过的类

[KaiXuan666]

我正在使用这个库开发app，在文档不齐全的时候只能去找demo，然后结合自己的理解去开发。深深感觉到文档对一个开源库的重要性。

我可以为这个项目贡献一部分时间。

希望能pr一个新分支作为文档的开发分支。

大佬加个扣交流呗997208868

[hzgotb]

PureViewComponent
SourceFlowAdapter
DynamicFlowAdapter
StateKey
TickerProviderMixin
ClearOnDependenciesChanged

[adigest]

动画、TickerProviderStateMixin、KeepAliveStfState、AOP等没有详细的使用说明，
希望文档里能加上

[hzgotb]

动画、TickerProviderStateMixin、KeepAliveStfState、AOP等没有详细的使用说明，
希望文档里能加上

好的。

[nepaul]

有没有一些最佳实践规范指南？
或者一些大型项目实践规范？

[yangchongduo]

能不能把文档弄好点，宣传做的挺好，最基础的文档都没有

[caoyanglee]

文档快点丰富下，不然我只能弃坑了...... #676 #