Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more documentation #374

Open
Vkt0r opened this issue Mar 27, 2019 · 1 comment
Open

Add more documentation #374

Vkt0r opened this issue Mar 27, 2019 · 1 comment

Comments

@Vkt0r
Copy link
Member

Vkt0r commented Mar 27, 2019

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 Vkt0r self-assigned this Mar 27, 2019
@Vkt0r Vkt0r pinned this issue Apr 9, 2019
@drekka
Copy link

drekka commented Jul 19, 2020

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants