active-group / active-group/active-clojure

Separate documentation files for separate features

Abierto
#49 0 comentarios 0 reacciones 0 asignados Ver en GitHub
documentation improvement
Lenguaje dominante
Clojure
Estrellas
31
Forks
4
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.