Why CDOC?
User Manual
Development
Github
LOGO
Why CDOC?
User Manual
Development
Github
UI On Github

We want cdoc to be as usable without leaving Github as possible. For every PR we will have one main page on FifthTry: PR Page

Since we are going to update Pull Request with our messages and different teams may want different levels of “messing with PR UI”, we would in future support multiple UI modes, for now we have just one mode, which we consider the ideal mode and want to use for our projects.

Upto-date
Missing
This document is not yet translated to ⁨English⁩. You are seeing ⁨English⁩ version.
Never Marked
The translation of this document is not yet approved.
Show unapproved version
Out-dated
The ⁨English⁩ document was last modified on ⁨Never Synced⁩. Since then, the ⁨English⁩ version has the following changes.
This document is out dated.
Show latest version
View changes
The following changes has been made in English edition since last modification


PR Check
This is the main UI for us.
We will have a check named “cdoc” which will show up here, like we currently see “Rust Checks / Rust Checks (pull_request)”. It will show passing or failing message. We will explore if “Details” link can directly to {pr-status.page}.
Status Summary
We want to try using PR Description for status, but it has some race condition issues. If the race condition mitigations are not considered acceptable we can switch to last comment for status.
Why CDOC?
User Manual
Development
Github
Table of contents:
Flow
Permissions
Three Approvals
Github UI
PR Description
Race Condition
Last Comment UI
PR States
Pages
PR Page
Repo Page
ftd Page
LOGO
Why CDOC?
User Manual
Development
Github
UI On Github

We want cdoc to be as usable without leaving Github as possible. For every PR we will have one main page on FifthTry: PR Page

Since we are going to update Pull Request with our messages and different teams may want different levels of “messing with PR UI”, we would in future support multiple UI modes, for now we have just one mode, which we consider the ideal mode and want to use for our projects.

Upto-date
Missing
This document is not yet translated to ⁨English⁩. You are seeing ⁨English⁩ version.
Never Marked
The translation of this document is not yet approved.
Show unapproved version
Out-dated
The ⁨English⁩ document was last modified on ⁨Never Synced⁩. Since then, the ⁨English⁩ version has the following changes.
This document is out dated.
Show latest version
View changes
The following changes has been made in English edition since last modification