swifter icon indicating copy to clipboard operation
swifter copied to clipboard

Add more documentation

Open Vkt0r opened this issue 6 years ago • 1 comments

I've seen people struggling to understand how the library works for several cases like loading files, serving responses, etc. (#371, #354, #350). We have some examples in the DemoServer.swift and brief docs about how everything works but we can create a more robust documentation with examples and explanations in the best way that everybody can contribute it.

This ticket would track the progress of that!

Vkt0r avatar Mar 27 '19 03:03 Vkt0r

Not sure if this would help but Jazzy is a pretty good API documentation generator. I've used it a number of times and it's pretty good at incorporating markdown and other documents into the generated website.

drekka avatar Jul 19 '20 05:07 drekka