Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(content): intro section tidy up #1225

Merged
merged 6 commits into from
Oct 19, 2020
Merged

fix(content): intro section tidy up #1225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b3be5c3
deletes outdated TODOs and diagrams and puts updated state diagram
yiannisbot Oct 19, 2020
d9724ea
embeds mermaid diagram as an embedded file
yiannisbot Oct 19, 2020
1f20fa7
Merge branch 'master' into intro-tidy-up
yiannisbot Oct 19, 2020
f66f697
linking .mmd file path to be relative to the content folder
yiannisbot Oct 19, 2020
c88da2a
path typo
yiannisbot Oct 19, 2020
4fb7dcf
Merge branch 'master' into intro-tidy-up
hugomrdias Oct 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 2 additions & 19 deletions content/intro/arch.md
View file
Open in desktop
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please use the file embed instead of inlining.

mermaid shortcode will probably go away.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, done!


![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
View file
Open in desktop
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
View file
Open in desktop
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',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove this plz

Copy link
Collaborator Author

@yiannisbot yiannisbot Oct 19, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hugomrdias do you mean set it back to "dark". It looks pretty horrible in my browser with most blocks having black letters on black background. Is there a problem with the "forest" theme?

flowchart: { useMaxWidth:true }
});
</script>
Expand Down Expand Up @@ -58,4 +58,4 @@
};
mermaid.render('temp-{{ $uuid }}', {{- .Inner -}}, insertSvg)
</script>
{{ end }}
{{ end }}