Skip to content
John Luxford edited this page Jan 11, 2023 · 11 revisions

This repository hosts the Flipside user manual / online documentation, available at:

https://www.flipsidexr.com/docs

Staging site updates

  1. Modify the files under the docs folder in this branch of this repository.
  2. Store any linked files in the Flipside website backend under Content > Files > docs > 2023.1.
  3. Commit your changes and push them to GitHub.
  4. Go to Flipside Admin > Tools on the staging website and log in.
  5. Click Publish documentation updates from GitHub and click Ok to confirm.

The staging website's documentation should update within 1-2 minutes.

Note: Linked files should live on the live website and be linked by their full URLs so that links don't break when the latest documentation is published to the live website.

Live site updates

To make changes to the live website documentation:

  1. Modify the files under the docs folder in this repository.
  2. Store any linked files in the Flipside website backend under Content > Files > docs.
  3. Commit your changes and push them to GitHub.
  4. Go to Flipside Admin > Tools on the website and log in.
  5. Click Publish documentation updates from GitHub and click Ok to confirm.

The website's documentation should update within 1-2 minutes.

Clone this wiki locally