active-group / active-group/active-clojure

Separate documentation files for separate features

Aperta
#49 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
documentation improvement
Lingua principale
Clojure
Stelle
31
Fork
4
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.