Docs | Manual Docs

These are the instructions for adding or contributing to manual doc sets in Wat.

Step 1: Fork

Fork the project on GitHub.

$ git clone git@github.com:username/wat.git
$ cd wat
$ git remote add upstream git://github.com/dthree/wat.git

Step 2: Adding / editing content

Add your content! Ensure you follow the editing guidelines.

Step 3: Rebuild

Wat uses an index file that keeps data on all of its documents. When you have finished editing and are ready to push your changes, you'll need to rebuild the index.

$ npm install -g gulp
$ gulp index

This action will also "lint" all of the document content and ensure it meets standards. Correct anything it notes and run gulp again until it passes.

Step 4: Commit

Make sure git knows your name and email address:

$ git config --global user.name "Jhonny Octocat"
$ git config --global user.email "joctocat@gmail.com"

$ git add .
$ git commit -m "added mocha docs"

Step 5: Push

git push

Go to your fork on Github. Click the 'Pull Request' button and fill out the form.

Step 6: Show off your docs

Made your project more accessible by contributing to Wat?

Show it off by copying the badge below into your README.md.

[![Wat: Documented](https://img.shields.io/badge/wat-documented-blue.svg)](https://github.com/dthree/wat)