1
0
Fork 0

fix(docs): add skeleton architecture doc

This commit is contained in:
ssube 2020-08-14 17:53:59 -05:00
parent b7b3c5f00a
commit a50f36b6c3
Signed by: ssube
GPG Key ID: 3EED7B957D362AF1
1 changed files with 69 additions and 0 deletions

69
docs/arch.md Normal file
View File

@ -0,0 +1,69 @@
# Architecture Guide
This guide describes the program architecture.
## Contents
- [Architecture Guide](#architecture-guide)
- [Contents](#contents)
- [Purpose](#purpose)
- [Label](#label)
- [Flag Label](#flag-label)
- [State Label](#state-label)
- [State Label Value](#state-label-value)
- [Remote](#remote)
- [Github Remote](#github-remote)
- [Gitlab Remote](#gitlab-remote)
- [Sync](#sync)
- [Sync Issues](#sync-issues)
- [Sync Labels](#sync-labels)
## Purpose
`cautious-journey` exists to manage labels and their workflow.
## Label
While `cautious-journey` reads issue data, labels are what it cares about.
### Flag Label
Flag labels are set individually. While they may depend on or even remove each other,
they are not connected directly.
### State Label
State labels are set from a group. Only one value from each state may be set at a time,
and the highest priority value automatically replaces any others.
#### State Label Value
Individual values within the state.
## Remote
`cautious-journey` manipulates issues and labels that exist on some remote service.
### Github Remote
Connects to a Github repository.
- `path`
### Gitlab Remote
Connects to a Gitlab repository.
- `path`
## Sync
Update issue labels or the labels themselves.
### Sync Issues
Update issue labels.
### Sync Labels
Update project labels.