In this tutorial you will learn how to fork a GitHub repository and make changes that you can after commit in our documentation repository

Create a GitHub account

First thing you will need to do is create a GitHub account in case you don’t have one.

Follow the steps and complete the sign up form as on any other site.

Forking the documentation

In the bottom of any page from the documentation, you will see the Fork button.

Click on it and you will be taken into your GitHub account or asked to sign up first if you are not already.

A copy of our main repository will be created in your account

Here you can edit any file related to AVChat Standalone or the AVChat Integrations

Editing the documentation files

The AVChat Standalone files are located inside the _includes folder and are named after every major chapter i.e. design.md, features.md, etc.

The AVChat integration files are located in the root of the repo and are named after the integration i.e. drupal.md, joomla-3.md, etc.

To edit it follow these steps:

  1. Click on the file you wish to edit.
  2. The file will open inside the browser. For this tutorial I’ve opened up design.md.
  3. Click on the Edit button showed in the image above.
  4. Now you can edit any part of the file writing in Markdown (it is very simple, you can learn it by example with what is already written).
  5. Select Create a new branch for this commit and start a pull request.
  6. Make your changes and click Propose file change

We will be notified that a new pull request exists and after reviewing it we will accept the change and will be viewable in the main documentation.