Feature Highlights
cDoc supports the following main features.
Github Support
Currently cDoc supports repositories stored on Github. Support for Gitlab, BitBucket are on our roadmap.
Github Login
People can login on cDoc using their Github account.
Github PR Check
cDoc acts a PR Check on Github. PRs can not be merged if checks do not pass.
Post Connect PR Comment
cDoc adds a comment to a PR when someone connects code PR with doc PR so the people working on the PR are informed about what is happening. The comment is posted on behalf of the Github user who connected the two PRs.
Comment on PR So All Collaborators Are Updated
Post Approval PR Comment
Once a doc PR is approved to be good enough for code PR, a comment is posted on the code PR on the behalf of the person who approved it.
A Comment Is Posted On Github When PR Docs Are Approved
Approval Requires Signature
We require the approvar to sign their name while approving.
Approve Has To Sign Their Name
Code PR Without Docs
Sometimes for a bug fix or some minor change, refactor, documentation is not required. We support that as well.
In Case You Don’t Need Docs! Use It Judiciously!
You will still have to put your name behind it, and soon only people with right permission will be able to perform this action.
Sign Your Name To Confirm This PR Does Not Need Documentation
One To One Code Repo to Doc Repo Connection
Currently cDoc only allows one to one mapping between code repo and doc repo. For each code repo there must exist a doc repo.
Checkout glossary for meaning of some of these terms.
TODO: Disconnect PR
Currently there is no way to disconnect a PR after it has been connected.
© 2023 FifthTry. All rights reserved
