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.

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 spelling errors in Documentation #298

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/learn/advanced/consensus.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ Whatever the reason for the diverging logs for a single Stream, it is important

#### Earliest Anchor Wins

Updates to Ceramic Streams are periodically [anchored](../glossary.md#anchor-commit) onto a blockchain (currently Ethereum). This immutable proof-of-publication is used to get a trustless timestamp for when the update occurred. This allows us to safely compare the timestamps associated with different branches of a Stream's log to determine which update happened first. When there are conflicting histories for a Stream log and one branch was anchored earlier than the other, the branch that was anchored earlier wins. If one branch was anchored and the other not, then the branch that was anchored is prefered.
Updates to Ceramic Streams are periodically [anchored](../glossary.md#anchor-commit) onto a blockchain (currently Ethereum). This immutable proof-of-publication is used to get a trustless timestamp for when the update occurred. This allows us to safely compare the timestamps associated with different branches of a Stream's log to determine which update happened first. When there are conflicting histories for a Stream log and one branch was anchored earlier than the other, the branch that was anchored earlier wins. If one branch was anchored and the other not, then the branch that was anchored is preferred.

#### Longest update chain

The Earliest Anchor Wins rule can solve many problems related to coming to consensus on a Stream's state, but still has issues if multiple updates are created quickly. Since anchors only happen periodically (depends on the anchor service being used, but currently twice a day for the anchor service that 3Box Labs operates for Ceramic mainnet), multiple updates can be created and published before any of them get anchored. In that case, we still need to come to consensus on the current state. When there are conflicting logs for a stream neither of which have been anchored, we prefer whichever log is longer. This ensures that the most active history with the most updates is preserved. If there are conflicting unanchored branches that have the same length, then the system picks the winning log arbtrarily, but deterministically, to ensure that all nodes come to agreement on the same log, even if there is no good information available to use to decide which to prefer. This can result writes being lost in certain rare instances where there are conflicting updates published within a few seconds of each other.
The Earliest Anchor Wins rule can solve many problems related to coming to consensus on a Stream's state, but still has issues if multiple updates are created quickly. Since anchors only happen periodically (depends on the anchor service being used, but currently twice a day for the anchor service that 3Box Labs operates for Ceramic mainnet), multiple updates can be created and published before any of them get anchored. In that case, we still need to come to consensus on the current state. When there are conflicting logs for a stream neither of which have been anchored, we prefer whichever log is longer. This ensures that the most active history with the most updates is preserved. If there are conflicting unanchored branches that have the same length, then the system picks the winning log arbitrarily, but deterministically, to ensure that all nodes come to agreement on the same log, even if there is no good information available to use to decide which to prefer. This can result writes being lost in certain rare instances where there are conflicting updates published within a few seconds of each other.

#### Simultaneous updates

Expand Down
2 changes: 1 addition & 1 deletion docs/learn/blog.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The [**Ceramic Blog**](https://blog.ceramic.network){:target="\_blank"} contains

## Featured videos

[**Learn how to manage user data in a Web3 app with IDX**](https://blog.ceramic.network/learn-how-to-manage-user-data-in-a-web3-app-with-idx/){:target="\_blank"}: Learn how to manage user data for your Web3 application with IDX. This talk is a workshop from tthe ETHDenver 2021 hackathon.
[**Learn how to manage user data in a Web3 app with IDX**](https://blog.ceramic.network/learn-how-to-manage-user-data-in-a-web3-app-with-idx/){:target="\_blank"}: Learn how to manage user data for your Web3 application with IDX. This talk is a workshop from the ETHDenver 2021 hackathon.

[**Standards for encrypted and mutable data on IPFS**](https://blog.ceramic.network/standards-for-encrypted-and-mutable-data-on-ipfs/){:target="\_blank"}: Joel talks about new standards for signed, encrypted, mutable data on IPFS. This is a talk from the ETHDenver 2021 hackathon.

Expand Down
4 changes: 2 additions & 2 deletions docs/learn/highlighted-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ Decentralized universal profiles available for use throughout the web3 metaverse

|Project |Description |Demo |Code Repo|
|-----|----|-----|--|
|[DAOHaus](https://daohaus.club/)| To help DAOs better understand who is participating in thier communities, DAOhaus is using Ceramic to create rich and robust member profiles.|[Blog Post](https://blog.ceramic.network/daohaus-adds-rich-dao-member-profiles/)|[Github](https://github.com/HausDAO/daohaus-app)|
|[DAOHaus](https://daohaus.club/)| To help DAOs better understand who is participating in their communities, DAOhaus is using Ceramic to create rich and robust member profiles.|[Blog Post](https://blog.ceramic.network/daohaus-adds-rich-dao-member-profiles/)|[Github](https://github.com/HausDAO/daohaus-app)|
|[DNS.xyz](https://beta.dns.xyz/)|DNS.xyz uses Ceramic to allow users to create and manage a universal profile.|||
|[Titter](https://twitter.com/dabit3/status/1515698468949573634)|Titter is a prototype of a web3-native social application, using Ceramic for editable, self-sovereign user profiles.|[Demo](https://twitter.com/dabit3/status/1515698468949573634)|[Github](https://github.com/dabit3/titter)|

### Reputation
This includes any publicly veriable attestations for skills, credentials, and contribution scores.
This includes any publicly variable attestations for skills, credentials, and contribution scores.

|Project |Description |Demo |Code Repo|
|-|----|-----|--|
Expand Down
2 changes: 1 addition & 1 deletion docs/learn/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ to both ComposeDB and the underlying Ceramic protocol. Concurrently, we seek to
community in shaping Ceramic's future. We value your active participation in helping us prioritize the features
and improvements that matter most to our developer base.

**All curent and future projects are outlined in the [Ceramic roadmap](https://github.com/orgs/ceramicstudio/projects/2).**
**All current and future projects are outlined in the [Ceramic roadmap](https://github.com/orgs/ceramicstudio/projects/2).**

We welcome your feedback and insights on our roadmap priorities. You can show your support or express your concerns
about projects on the roadmap by upvoting or downvoting them. Additionally, we encourage you to leave more detailed
Expand Down