Skip to content

Better documentation #26

Description

@jgillich

Our current documentation in the form of the README will only go so far before becoming convoluted. There are some features that could be explained in more detail, and some features are lacking documentation entirely.

What I'd like to do is to move to more structured content using mkdocs, similar to the Crystal book. But I'm not actually very good at writing documentation. So if anyone's a better writer and interested in contributing, please leave a comment.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions