This repository contains the source files for the Alpha Blend Interactive Documentation available under docs.abinteractive.net
- master is our production branch, means anything in master goes/is in the production site at docs.abinteractive.net
- develop is our main development branch, merge and base your changes to/from here
Please contribute using GitHub Flow. Create a fork, add commits, and open a pull request.
For any changes, make a feature branch.
This means a branch named like feature/add-cvravatar-feature-docs
with a reasonable short name of the changes you are doing there.
When you are done with your changes, merge them into develop.
Release are made by ABI staff.
Additional notes: For deploying to production merge develop into master, and grab the latest build artifact from teamcity after it has been built.
We recommend previewing the site before submitting your PR. To preview the site, follow the instructions below:
- Install CPython
pip install -U poetry
cd path/to/docs
poetry install --no-root
mkdocs serve