Update architecture-overview.md #284
Conversation
Added some grammatical and syntactical changes to the Architecture Overview file. I also think the term Paratime should be used in the same way that Polkadot uses Parachain. That is, the T in Time should not be capitalized, since the T in runtime is not capitalized either. Thus, we can refer to the Paratime concept as a proper noun and then when discussing various paratimes we can use it in the lower case. Is there any reason why we call it the Oasis Runtime instead of Oasis Paratime? If we are going to develop a new terminology, we should aim to use it consistently.
|
|
||
| In addition to a decentralized Consensus Layer, Oasis will also allow for anyone | ||
| to add their own runtime to the Network. The system was developed this way in | ||
| to add their own parallelizable runtime, or paratime, to the Network. The system was developed this way in |
There was a problem hiding this comment.
Line too long. You'll need to wrap lines to 80.
| @@ -128,11 +127,13 @@ identification. See [Entities and Key Management] for further information. | |||
| ### Committee | |||
|
|
|||
| A Committee is a set of Nodes that are participating in the same service layer | |||
| of the Oasis Network. Committees are described in more detail in the [Modular | |||
| Architecture] section. | |||
| of the Oasis Network. Our consensus model is described in more detail in the [Decentralized Consensus Layer] section. | |||
There was a problem hiding this comment.
Not sure what you mean about line length here? I looked over the documentation and a source code line does not map to a line on the webpage, as can be seen here, for example https://docs.oasis.dev/hsm/ledger.html#prerequisites - it seems like the CSS takes care of text-wrapping, so we don't need to worry about lines being too long in the source code. My preference to keep it long is that it makes it easier to edit down the line, otherwise we will have to keep editing spacing each time we make a wording change. And Github takes care of text wrapping in the preview too. What do you think?
|
@jcueto these edits look great. Chatted with Anne. Let's keep ParaTime as is. We can still reference it as a proper noun. As far as ParaTime vs runtime, this is a bit tricky. Will ping you offline. Runtime is a valuable descriptive term, that being said, I agree with your thinking that we should try to promote our branded term if we can. |
|
@jcueto can we get this PR finalized tomorrow? |
|
@armiller123 what is missing for this commit to go through? |
|
@jcueto just need to update the Paratime >> ParaTime to stay consistent with other docs then it should be gtg |
Fixed spacing issues
|
@armiller123 updated wording to ParaTime - please take a look |
Added some grammatical and syntactical changes to the Architecture Overview file.
I also think the term Paratime should be used in the same way that Polkadot uses Parachain. That is, the T in Time should not be capitalized, since the T in runtime is not capitalized either. Thus, we can refer to the Paratime concept as a proper noun and then when discussing various paratimes we can use it in the lower case.
Is there any reason why we call it the Oasis Runtime instead of Oasis Paratime? If we are going to develop a new terminology, we should aim to use it consistently.