active-group / active-group/active-clojure

Separate documentation files for separate features

オープン
#49 コメント 0 件 リアクション 0 件 担当者 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 を短くまとめたダイジェスト。