README

To write docs

1. Any comment that starts with --- or /// is a doc-string (i.e. 3 comment-characters in a row)
2. Doc-strings continue on until a non-docstring line
3. Doc-strings for modules contain === my.modulename ===, then any number of lines describing it
4. Doc-strings for items (functions, variables, etc.) go like this:
   1. The first line starts with my.modulename.item or my.modulename:item -- this is the item name
   2. Any non-alphanumeric character ends the item name and is ignored, i.e. parentheses or spaces:
      1. my.modulename:foo()
      2. my.modulename:foo(bar) -> string
      3. my.modulename.foo(bar, fn(int) -> int)
      4. my.modulename.foo = {}
   3. The second line is a single captitalized word, like "Variable" or "Function" or "Method"
   4. The remaining lines describe the item
5. Any comment that starts with 4 comment-characters is ignored
6. Anything in a directory _docsignore or subdirectory of it are skipped
7. Only files ending in .lua or .m are scanned

To generate docs

$ bundle install
$ make

To add your module

1. Add your repo's .tar.gz URL to Repos page in this wiki
2. Clone this repo
3. Generate docs (see above)
4. Verify the built Mjolnir.docset looks like it should
5. Send PR to https://github.com/kapeli/Dash-User-Contributions
   1. Fork his repo
   2. Copy build/Mjolnir.tgz (from step #3) into Dash-User-Contributions/docsets/Mjolnir/
   3. Update the version number in Dash-User-Contributions/docsets/Mjolnir/docset.json
   4. Send PR on our behalf