filecoin-project / filecoin-project/specs

Add diagram guidelines to style.md

Open
#372 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
SCSS
Stars
363
Forks
164
PR merge metrics
No merged PRs in 30d

Description

We use mermaid js for diagrams

Add conventions for diagrams to style.md, e.g.:
- Blockchains move to the right (for shorter chains) and down (for really long chains)

Contributor guide

No contributing guide indexed for this repository

Research direction

Open style.md and review the existing style guidance in the context of Mermaid JS diagrams. Add conventions for diagram layout, including the stated rightward direction for shorter blockchains and downward direction for very long chains. Done means the requested diagram guidelines are documented in style.md.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.