Skip to content

Commit

Permalink
fix(content): intro section tidy up (#1225)
Browse files Browse the repository at this point in the history
Co-authored-by: Hugo Dias <[email protected]>
  • Loading branch information
yiannisbot and hugomrdias authored Oct 19, 2020
1 parent d4311ca commit ba64d09
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 21 deletions.
21 changes: 2 additions & 19 deletions content/intro/arch.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,6 @@ dashboardAudit: n/a

# Architecture Diagrams

## Overview Diagram
{{< details title="TODO" >}}
- cleanup / reorganize
- this diagram is accurate, and helps lots to navigate, but it's still a bit confusing
- the arrows and lines make it a bit hard to follow. We should have a much cleaner version (maybe based on [C4](https://c4model.com))
- reflect addition of Token system
- move data_transfers into Token
{{< /details >}}
Actor State Diagram

![Protocol Overview Diagram](diagrams/overview1/overview.dot)

## Protocol Flow Diagram

![Deals on Chain](diagrams/sequence/full-deals-on-chain.mmd)

## Parameter Calculation Dependency Graph

This is a diagram of the model for parameter calculation. This is made with [orient](https://github.com/filecoin-project/orient), our tool for modeling and solving for constraints.

![Protocol Overview Diagram](diagrams/orient/filecoin.dot)
![Actor State Diagram](/intro/new-state-diagram.mmd)
19 changes: 19 additions & 0 deletions content/intro/new-state-diagram.mmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
stateDiagram

Null --> Precommitted: PreCommitSectors
Precommitted --> Committed: CommitSectors
Precommitted --> Deleted: CronPreCommitExpiry (PCD)
Committed --> Active: SubmittedWindowPoSt
Committed --> Faulty: DeclareFault\nSubmitWindowPoSt (SP)\nProvingDeadline (SP)
Committed --> Terminated: TerminateSectors\n(TF)
Faulty --> Active: SubmittedWindowPoSt (FF)
Faulty --> Faulty: ProvingDeadline (FF)
Faulty --> Recovering: DeclareFaultRecovered
Faulty --> Terminated: EarlyExpiration (TF)\nTerminateSectors (TF)
Recovering --> Active: SubmittedWindowPoSt (FF)
Recovering --> Faulty: DeclareFault\nProvingDeadline (SP)
Recovering --> Terminated: TerminateSectors (TF)
Active --> Active: SubmittedWindowPoSt
Active --> Faulty: DeclareFault\nSubmitWindowPoSt (SP)\nProvingDeadline (SP)
Active --> Terminated: CronExpiration\nTerminateSectors (TF)
Terminated --> Deleted: CompactSectors
4 changes: 2 additions & 2 deletions layouts/shortcodes/mermaid.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<script>
mermaid.initialize({
startOnLoad:false,
theme: 'dark',
theme: 'forest',
flowchart: { useMaxWidth:true }
});
</script>
Expand Down Expand Up @@ -58,4 +58,4 @@
};
mermaid.render('temp-{{ $uuid }}', {{- .Inner -}}, insertSvg)
</script>
{{ end }}
{{ end }}

0 comments on commit ba64d09

Please sign in to comment.