google / google/codeworld

API documentation needs a custom theme

未关闭
#8 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
enhancement
主要语言
Haskell
星标
1.3k
派生
201
PR 合并指标
30 天内没有已合并 PR

描述

We should see try to theme haddock to make the API documentation less busy. Things like instances should be removed. The page structure should be re-organized to remove references to modules (like Prelude). Confusing notation should be removed for fixity declarations (or the entire fixity removed if it can't be phrased in a more friendly way.)

贡献指南

打开贡献指南

调研方向

首先确定 Haddock 当前如何生成 API 文档,并检查对实例、Prelude 等模块引用以及 fixity 声明的处理方式。完成的标准是:采用一个不那么繁杂、页面结构更清晰的自定义主题,去除不必要的实例或模块引用,并在保留 fixity 的情况下使用更易理解的 fixity 表示法。

由索引模型根据 Issue 内容生成。

评估

技术栈
haskell
领域
documentation
Issue 类型
文档
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
20/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。