Welcome to the Snoring Ninja documentation repository, powered by with mkdocs.

We welcome and encourage all help with writing and maintaining documentation for any of our projects. With that being said, please keep a few things in mind:

• All updates should be made via markdown files in the src/ directory
• If you build locally using our mkdocs.yml file, that's fine - just please, don't push the docs/ folder then
• Please make sure all commits contain [skip ci] as the prefix for the commit (to prevent builds, we again prefer to do that)
• Please make sure all pushes contain decent enough commits so we know what you did - we may deny all pull requests that don't have decent documentation via the commit message

Docs deployment is currently broken and rather useless - we're working on fixing that.