Read CONTRIBUTING.md for more details on contributing documentation improvements.
Read style-guide.md for our guidelines on how to write documentation.
Fork and clone this repository. Issue pull requests one document at a time.
-
Install the following:
-
Run
vagrant up
from inside the project root directory (documentation
). -
You will be prompted for the administration password on your host machine. Obey.
-
Visit http://docs.local:8000/docs in your browser of choice.
-
Run
vagrant provision
to update the local site. Alternatively, you can watch for CSS and file modifications so that changes are reflected automatically:vagrant ssh -- -t 'cd /vagrant; fuser -k -n tcp 8000;grunt watch & ./bin/sculpin generate --server --watch'