Make the high level overview easier to scan#165
Merged
Conversation
…formation to give anyone an understanding of credible layer in 2 minutes
Contributor
growth-maniac
left a comment
growth-maniac
left a comment
There was a problem hiding this comment.
looks good. one comment.
| #### How Enforcement Works | ||
|
|
||
| You can read the full technical flow in [Architecture](/credible/architecture-overview). | ||
| A network node running the Credible Layer [sidecar](/credible/glossary#sidecar) does not care _how_ a transaction violates the protocol's rule. All that matters is _whether_ the assertion passes or fails. If the assertion fails, the node drops the transaction before it can be included in a block. |
Contributor
There was a problem hiding this comment.
shouldn't we use validated/invalidated instead of pass/fail here?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
During mapping of personas and user journeys for the docs, it became clear that the high level overview was too hard to navigate and had too much content. This PR boild it down and moves the code example into a dropdown so that non-tech people can get an understanding of the Credible Layer in a couple of minutes.