active-group / active-group/active-clojure

Separate documentation files for separate features

Ouverte
#49 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
documentation improvement
Langage dominant
Clojure
Étoiles
31
Forks
4
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.