Docs | 101

Contributing to Wat Docs

You've come to the right place!

There are three major ways to contribute documents:

Auto docs

If a software library, platform or language has its API documentation available on the web in markdown, automatic document sets can be generated. It takes less than 15 minutes to add a library!

Learn how to add auto docs.

Manual docs

If a language, platform or library's API docs are not available in markdown format, you can manually generate document sets for Wat. This needs to be maintained by the community, so preferably create these for sufficiently large libraries that will be kept up to date, such as Javascript, CSS or lodash.

Learn how to add manual docs.

Docset generators

Wat supports extensions called docset generators, for building Wat auto docs from various sources. Markdown is currently the only available generator, however the next two most important generators I am trying to develop are for GoDocs and HTML pages.

Want to help make a generator, ping me on Github, Email me or join the Gitter channel.