-
Notifications
You must be signed in to change notification settings - Fork 467
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
Docs improvements #952
base: main
Are you sure you want to change the base?
Docs improvements #952
Conversation
@tudorpintea999 is attempting to deploy a commit to the Consensys Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few comments and some good corrections.
Please undo all your changes in the api/linea-smart-contracts
directory — the text here is autogenerated and would need to be edited at source rather than in these Markdown files.
@@ -3,7 +3,7 @@ title: Spheron network | |||
image: /img/socialCards/spheron-network.jpg | |||
--- | |||
|
|||
[Spheron Network](https://www.spheron.network/) is a decentralized compute provider and marketplace | |||
[Spheron Network](https://www.spheron.network/) is a decentralized computing provider and marketplace |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Spheron Network](https://www.spheron.network/) is a decentralized computing provider and marketplace | |
[Spheron Network](https://www.spheron.network/) is a decentralized compute provider and marketplace |
computing =/= compute, and although the latter isn't really standard English as a noun, I see it enough to justify keeping it here. Perhaps an alternative would be "computing infrastructure" or "computing capacity", but I think we should stick with the author's original choice if in doubt.
@@ -23,7 +23,7 @@ Irys is **chain agnostic**; smart contracts on Linea can link to data on Irys. | |||
You can: | |||
|
|||
- Deploy NFT contracts on Linea and [have images and metadata on Irys](../../../../learn/ecosystem-tutorials/irys/irys-nfts.mdx) | |||
- Build games with state on Linea and visual assets on Irys | |||
- Build games with the state on Linea and visual assets on Irys |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Build games with the state on Linea and visual assets on Irys | |
- Build games with state on Linea and visual assets on Irys |
State is frequently used without an article, so I don't think we need this
docs/risk-disclosures/index.mdx
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good find, but per our internal style guide I think this should actually be cryptoassets
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
as above, state
is abstract and doesn't mean state in the traditional sense, so this is fine
@@ -160,7 +160,7 @@ The Ethereum Virtual Machine (EVM) uses a variant of a Merkle tree known as a [M | |||
- Account storage state (or simply 'storage'), which keeps track of the contents of each account. | |||
|
|||
On Linea, we adapt this structure. The Merkle-Patricia Trie is still used for world state, but the | |||
custom cryptographic accumulator described above is used for account storage state. | |||
custom cryptographic accumulator described above is used for the account storage state. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
custom cryptographic accumulator described above is used for the account storage state. | |
custom cryptographic accumulator described above is used for account storage state. |
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Hello
While reading the docs , my OCD observed some minor typos that I fixed here
Hope it helps,
Br,
Tudor