cDoc Glossary

When using cDoc on a day to day basis we use some common terms whose definition is given here.

Code Repo and Doc Repo

cDoc works with software stored in Github Repositories. Also code and documentation should be stored in their own repositories. The code is stored in code repo and documentation in doc repo.

Connected Repos

A doc repo and code repo may exist in Github, but may not yet be “connected repo” as per cDoc. To connect a code repo with corresponding doc repo one has to install the cDoc Github App, grant access to the repositories and then follow the “connect journey” as described in the setup blog post.

After the doc repo and code repo are considered connected repos.

Code PR and Doc PR