Documentation

Learn how to manage your white-labelled support documentation for your clients

Creating Your Support Documentation

1. Visit https://github.com and create an account.

2. Visit https://www.gitbook.com and register an account.

3. Go to https://github.com/realfresh/cw-docs and press the fork button on the top right to create your own copy under your account or use an existing desired repository. It holds significant importance to fork files prior to initiating synchronization with GitBook.

1. Go back to GitBook and create your first documentation space.

2. In your documentation space, using the top navigation bar, select integrations.

1. Enable and install GitHub Files in the integrations list.

1. Go back to the selected documentation space and select “Synchronize with Git”.

1. Then select GitHub as a provider then click Configure.

1. Connect your account with GitHub.

1. Select your account or install GitHub Application. Make sure you are logged in to GitHub to automatically pull the account.

1. Select “cw-docs” for the repository and “master” for the branch.

1. Scroll down and select “Synchronize”. Make sure GitHub to GitBook is the chosen priority.

1. After this, your forked documentation repository will be synced over to GitBook.

2. At this point, you can follow the editing steps below to make changes.

Editing Your Support Documentation

1. Visit https://www.gitbook.com and login to your account

2. Select your documentation site

3. Press the edit icon button on the bottom right

4. Make any changes as needed

5. Once done, press the save button on the bottom right

6. On the left nav bar, you will see an active draft with a blue button saying "Merge"

7. Press merge to update the docs with the draft changes just made