User Guide

Table of contents

  1. Overview

1. Overview Table of Contents

We use Jekyll to serve our user guide locally and deployment to GitHub pages. The live link for our user guide can be found here

If you want to update this guide for your own project the files for this guide can be found at the docs directory under project root. The files uses the .md extension. While creating your own guide you can serve the guide locally by running the following command:

php console serve:docs --port=<port_number> --host=<hostname_or_ip>

Once the server is running proceed to the following URL: http://<hostname_or_ip>:<port_number. The default is http://127.0.0.1:4000/<project_name>/.