active-group / active-group/active-clojure

Separate documentation files for separate features

Open
#49 0 comments 0 reactions 0 assignees View on GitHub
documentation improvement
Dominant language
Clojure
Stars
31
Forks
4
PR merge metrics
No merged PRs in 30d

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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.