Mautic user documentation (new)

This repository hosts the new end-user documentation for Mautic on the Read the Docs platform. Whenever a PR is merged, changes are deployed immediately to https://mautic-documentation.readthedocs.io/

If you're looking for our current end-user documentation, please go to https://docs.mautic.org/ or the GitHub repository.

Migration of end-user docs to Read the Docs

We aim to move all aspects of the end-user documentation to Read the Docs.

For more background, our end goal, and to let us know if you want to help, please join the Education Team channel (#t-education) on Slack (get an invite at https://mautic.org/slack). Thanks in advance!

Build documentation locally

• RST Syntax Cheatsheet
• Sphinx Demo
• Sphinx Syntax

The following provides instructions for how to build docs locally for visualization without pushing to the remote:

1. Install Python 3 for your OS if not already installed
2. Install Sphinx pip install sphinx
3. Install sphinx-rtd-theme pip install sphinx-rtd-theme
4. CD into the docs directory cd [path to this repo]/docs
5. Run make html
6. This will generate HTML in docs/build/html. Setup a web server with the web root as docs/build/html or open docs/build/html/index.html in a browser.

Vale

Before pushing, run Vale and address suggestions and errors as applicable.

1. Install vale
2. vale .

PhpStorm/PyCharm File Watcher

You can automatically build changes to rst files using a file watcher.

1. Go to Preferences -> Tools -> File Watchers -> + button -> custom
2. Configure the watcher as presented in the screenshot