search

clj-commons / aleph

Asynchronous streaming communication for Clojure - web server, web client, and raw TCP/UDP
http://aleph.io
MIT License
2.54k stars 241 forks source link

Update examples and docs #653

Closed arnaudgeiser closed 1 year ago

arnaudgeiser commented 1 year ago

Fixes #629

arnaudgeiser commented 1 year ago

Have you tested it with local cljdoc? Fair warning, it can get a bit tricky. I have some scripts for deps.edn-based repos, but not lein.

Happy to hear that, because it took me a while to understand how to work with a local cljdoc. The documentation is great, but I didn't get it initially. Yes, it has been tested.

Please note I had an heavy hand with ^:no-doc here.

Here is the result :

image

image

image

image

image

image

image

image

arnaudgeiser commented 1 year ago

Please let a thumbs up on this comment if you are fine with my choice. I removed more than 50% of the functions on the documentation, and the whole http/server.clj, http/core.clj, http/client.clj, http/encoding.clj namespaces.

I was not able to remove ->Cookie from the documentation as potemkin p/derived-map is not supporting metadata so far.

arnaudgeiser commented 1 year ago

Actually, it's just documentation. If I've been too aggressive, we'll change it back. Merging.