Documentation Enhancement

[Akeboshiwind]

I've been thinking about expanding some of the docstrings, but I'm not sure how is best to go about it.

One option is to just copy the output of the help function but change it to use markdown instead of plain text, I've made a quick sample implementation here. I realise that this copy pasting of documentation makes it harder to keep updated so this option isn't perfect by any means. I also don't think that the documentation in meta has been updated in 2 years so it might not be perfectly up to date but presumably this can be easily fixed (I know that it definitely has one or two spelling mistakes to be fixed).

Another way I could achieve the same effect could be to change the functions in the help namespace to accept an output-type parameter, or something similar, to change the output to generate markdown instead of plain text. This would mean making a code change though and although I don't see the help function used anywhere else in the code, I don't know who else might be using it.

My question here is what do you think would be the best way to make this change? The hope is to eventually submit this as a pull request.

[ikitommi]

Hi. The help-ns was a test on how to built interactive docs. I don't think people use it. It would be much better to write really good docs for cljdoc. Basically this would mean a docs folder and lots of docs there. And some docstrings.

https://cljdoc.org/d/metosin/compojure-api/2.0.0-alpha27/