Why
Blog
Product Manual
Development
Introducing cDoc: Continuous Documentation
Setup continuous documentation for your Github Repo in under 2 mins!
Taste Of cdoc on Day To Day
Doc in Git™
Lack Of Documentation Is Costing You
Does Writing Documentation Slow You Down?

How to setup continuous documentation for your Github Repo

Continuous Documentation, cDoc helps you keep your documentation up to date with your changing code by blocking pull requests from getting merged till documentation has been written and approved.

Congratulations on taking a step towards better documentation for your team! Improving documentation is the highest return on investment activity you can do to make you team more productive and happy! If you are trying to be remote company, documentation is one of most crucial factors in success as a remote company, if you believe Gitlab!

In this post we will help you configure it for your repositories so you can start using it right away.

cDoc can be used via FifthTry, a SAAS offering, or you can download the open source cDoc source code and deploy it on your infrastructure from github.com/FifthTry/cdoc. The easiest way to try out cDoc to see if it good for your team, is to use our SAAS offering, which is FREE, no credit card required till you have crossed a certain usage threshold. You can checkout continuous documentation pricing page for more details.

Head over to FifthTry.com
In this video you saw how quickly you can set up Continuous Documentation by visiting FifthTry.com homepage, and clicking on the “Sign Up” button:

Click 1: Click On Signup On FifthTry.com

Install Continuous Documentation Github App
This will take you to Continuous Documentation Github App where you can click on the “Install” or “Configure” button.

Click 2: Install Our Github App
Click 3: Select The Account You Want To Install It On

Grant Us Access To Your Repos
Once installed you have to grant access to your Github repositories you want to use with Continuous Documentation.

Click 4: Grant Access - Preferably To “All Repositories”
Some people prefer giving access to all their repositories so repositories created in future are also available on FifthTry for you to use. Else in future you they have to go back to Github App and grant access to more repos. We respect your privacy, and we will never share access to data you give to use with third parties, and we will take utmost precautions to keep them safe.

Connect Your Doc Repo With You Code Repo
Once you grant us access, Github will redirect you to back to FifthTry.com, where you will find the repositories you have granted us access to.

You Are Back to FifthTry.com

The way continuous documentation, cDoc, works right now is by storing your code in one Github repository, and storing the documentation of that code in another Github repository. Learn more about our doc in git workflow.

You have to “connect” your code and doc repository next. You can locate your repository using search if you have too many repos:

Find Your Awesome Repo