Project IC123的目标和范畴

[zire]

这个项目的目的是为ICP的华语开发者创建一个完整的技术文档网站，包括新手引导，教学视频，代码示例，中文文档。本项目希望能联合IC生态里尽可能多的华语开发者力量，一起补充，完善ICP的技术文档，让这个网站可以成为一个华语开发者交流讨论的中心。

这个网站将会采用大量来自DFINITY基金会维护的开发者中心上的内容。英文开发者中心的架构如下，Github repo for the IC Dev Portal。

本网站目前部署在DFINITY亚太团队2022年早期创建的容器 egsco-7yaaa-aaaal-qa34a-cai 上，采用React上的Gatsby前端架构。原网站自从2022年7月后就没有维护了。新的容器部署好了后，将会替代这个老的容器。

有几个比较核心的问题，大家可以讨论一下，把项目的大致框架定下来：

1. Project 123是做成一个internetcomputer.org下面的的subdomain或者folder，还是采用一个独立的域名？
2. 如果走独立域名路线，用哪个域名来作为永久链接? (defaulted to be ic123.xyz)
3. 用什么样的前端架构 (defaulted to be Docusaurus)
4. 是应该把 IC Dev Portal 逐篇翻译（“搬砖”）, 还是重新设计符合华语开发者阅读和学习习惯的内容？
5. 可以邀请哪些开发者加入这个项目？
6. Project IC123除了技术文档以外，还有没有其他的内容也可以包括进来，譬如，跟生态相关的资讯 （Awesome IC project list）？
7. 项目组如何建立一个有效的可持续的沟通合作机制？
8. 应该怎样设立工作流 / workflow？需要一个什么样的CI/CD机制？
9. 在完成了首期的内容发布后，如何保障未来文档可以被持续更新，保持准确和完整？
10. 这个项目采用什么样的代号（Project XXX）比较酷炫拉风一些？目前是 Project 123 。

[zire]

关于Tech Doc前端架构的选择，目前IC Dev Portal 采用的是Docusaurus。Docusaurus有一个比较详细的跟其他前端框架的对比，可以看一下。其他的选择还有不少，从古典的Gitbook, Read the Docs, 到Doxygen，甚至就用Jekyll的Github Page也都可以考虑。基本原则是：

• 免费，不花钱
• 用Markdown语言，支持Markdown到HTML的编译器
• 界面简洁清爽
• 开发容易
• 尽可能降低对第三方工具的依赖性/dependency
• 可以实现Twitter Card的preview功能，方便在社交网络上转播
• 有强大的routing功能，可以容易地实现网页跳转

[Junweif2]

关于项目框架的一些想法：

1 & 4：如果从整体统一性考虑，子域名的形式可能会更合适，类似于多语言选择的跳转，独立域名可能会造成困扰，之后也可以加除了中英文外的语言版本，类似于以太坊基金会的网页，不过我不知道这里是不是也会相应多一些协调成本，不可避免需要和英文版本对齐？如果没有这方面的阻碍的话，页面可以设计符合华语开发者阅读和学习习惯的内容是最好的，同时也可以跑一遍基金会的开发者文档，筛选一遍最新的文档是不是可以跑通。

5：可以主要邀请生态内项目方的开发者，因为他们在实际开发过程中，会有各种各样的问题，可以整理一个Q&A类目

6：生态项目列表感觉可以沿用现在官网页面，或是直接挂社区内做生态浏览器的链接

7 & 8 & 9：这里有三个想法，第一个比较简单直接，开放提交PR，由专门的负责审核的人来合并，这样也可以看到社区的所有贡献者，一个例子是WTF，这里需要每个提交PR的人比较熟悉仓库结构；第一个是每一块具体的内容先由专门负责的人审核，审核后再提交，这样社区贡献者可能可以更专注于内容本身；第三个因为现在Mora上也维护了一份知识库相当于，有没有可能前端直接接Mora后段的罐子，从里面拿数据做展示，这样的话工作流就可以通过Mora完成，但好像一个星球只能有三个作者。

10：AwesomeIC ?

[zire]

看看刚刚更新的 https://ic123.xyz/docs/intro