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 摘要。