Rework docs to use polyglot notebooks
未关闭
还没有人认领这个 Issue。
Area: Documentation
- 主要语言
- F#
- 星标
- 860
- 派生
- 99
- 平均合并
- 22 分钟
- 30 天内合并 PR
- 1
描述
Since fsdocs now supports generation of documentation with notebooks as input, a rework of the docs that also offers side-by-side examples for F# and C# is overdue.
I think this should be done gradually with a mechanism that allows publishing the new and old docs together as long as not all pages are ported.
This also would be a huge step forward for #376 , at least in a way that we could provide the docs in a format that is needed for the official pipeline.
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先查看 fsdocs 对基于 notebook 的文档的支持以及 issue #376 中的要求。确定如何在逐步迁移期间同时发布新旧文档,然后定义并列展示 F# 和 C# 示例的范围以及官方 pipeline 格式。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- csharp, fsharp
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 25/100