Skip to content

Add more documentation #374

Description

@Vkt0r

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!

Activity

  1. self-assigned this
    on Mar 27, 2019
  2. pinned this issue on Apr 9, 2019
  3. drekka commented on Jul 19, 2020

    @drekka

    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

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions