active-group / active-group/active-clojure

Separate documentation files for separate features

未关闭
#49 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
documentation improvement
主要语言
Clojure
星标
31
派生
4
PR 合并指标
30 天内没有已合并 PR

描述

David's idea to remove redundancy between namespace docs and the top-level readme while (still) enabling comprehensive documentation:

- Create separate (markdown) files for the different library features/sublibraries.
- Link to those in the top-level readme (instead of the current slight clutter).
- Reduce namespace docstrings and also link to above documentation.

Slightly related: create a changelog that we can use to document breaking changes instead of those being the first thing you see here.

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

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