freshen docs #149
Comments
This was referenced Jan 24, 2023
lread
added a commit
that referenced
this issue
Jan 29, 2023
These can always be improved, but I think this is a good first pass. I'm also sure I made typos/mistakes, corrections are always welcome. - move from md to adoc to make the chore more pleasant for me - changelog now includes release dates and indications of breaking releases - readme is now a landing page that references change log, and user guide dev guide and maintainer guide - user guide is mostly old readme content with some elaborations - add `doc/cljdoc.edn` to explicitly tell cljdoc about articles - public API docstrings reviewed and updated - now markdown for better rendering on codox/cljdoc/etc - also helps with clarity when `args` and `types` are backticked - elaborated/reworded where I thought that would help - distinguished lower level fns from higher level ones in aether ns. - now more consistently referencing options defined in other fns. I'm sure some vars could have been internal, but I'm not about to change visibility at this point. - rename internal private `default-listener-fn` to `stdout-listener-fn` to better reflect its purpose Touches on #107. Closes #149
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
When I become a maintainer of a project I like to review docs.
This helps me understand the library I have volunteered to help maintain.
And, while I learn, sometimes I can add some details that I would have appreciated.
I've already added a developer guide.
I'll move most of the content from the README to a user guide.
And I'll also add an admin guide for maintainers to consult on such things as how to release pomegranate.
This is a bit of work, so I'm going to do it in a format I prefer: AsciiDoc.
Apologies to lovers of Github Markdown.
The text was updated successfully, but these errors were encountered: