tree: 97ef3a7fcdb58916cc3dcaf5e1dba253face829a [path history] [download]
  1. 0.6.x/
  2. 0.7.x/
  3. 404.html
  4. 500.html
  5. CNAME
  6. README.md
  7. _SOURCE/
  8. assets/
  9. changelog.html
  10. index.html
  11. sitemap.txt
docs/README.md

Contributing to the Website / Documentation

Thank you for your interest in contributing to the facil.io website and documentation.

NOTICE: _SOURCE is the folder that contains the actual documentation files. Edits to the documentation should be placed in this folder.

Anything outside the _SOURCE folder (including this file) is created automatically by the server script and shouldn't be edited.

If you want to contribute to the documentation, please do so by opening a Pull Request (PR) with updates to the files in the _SOURCE folder.

Running the website locally

It's possible to run a local version of the website using Ruby (make sure to have Ruby and Ruby gems available on your system).

Open the terminal window and go to the _SOURCE folder. Than run (currently runs on macOS and Linux):

$ bundle install
$ ./server