active-group / active-group/active-clojure

Separate documentation files for separate features

Aberta
#49 0 comentários 0 reações 0 responsáveis Ver no GitHub
documentation improvement
Linguagem predominante
Clojure
Estrelas
31
Forks
4
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

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.

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Avaliação

Esta issue ainda não foi avaliada.

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.