Documentation update #340
Documentation update #340
Conversation
This brings this spec in line with the current state of what's actually implemmented and it's nuances.
jkilpatr
requested review from
fedekunze,
jackzampolin and
tac0turtle
as code owners
There was a problem hiding this comment.
This documentation is not in the format that we are using, and much of the documentation of messages is not detailed enough. However, we may be able to extract some good stuff, for example the bootstrapping documentation. I recommend this not be merged, and instead be used as source material for the ongoing documentation efforts in the module spec folder
This documentation is objectively more complete than the current set, what's the timeline for 'properly formated' documentation? if it's more than a week why are we deciding that not having up to date documentation is better for that time period than having 'poorly formatted' documentation? |
| @@ -0,0 +1,89 @@ | |||
| # Gravity messages | |||
There was a problem hiding this comment.
This is contained within the module/spec. When we go to render the doucmentation, the spec in the module will be used. Can we merge any information from here into there?
There was a problem hiding this comment.
Where is the spec being worked on? I'll compare them on review.
|
|
||
| This is identical to Ethereum -> Cosmos for Ethereum based assets. Please see that section and refer to the above section for details on how the overall process differs for Cosmos assets. | ||
|
|
||
| ## Relaying rewards |
There was a problem hiding this comment.
should this be added into the rewards section?
There was a problem hiding this comment.
it's intended to be the EThereum -> Cosmos flow for Cosmos based assets but I wasn't sure how much duplication was really needed.
| @@ -0,0 +1,81 @@ | |||
| # Gravity parameters | |||
There was a problem hiding this comment.
This is already within the spec, why was it added here?
Please merge this into there
There was a problem hiding this comment.
ah I see it. Not open at the time of this PR's creation.
There was a problem hiding this comment.
https://github.com/cosmos/gravity-bridge/blob/main/module/x/gravity/spec/07_params.md
this was created a while ago. It lists the params but does not explain them.
|
Love the initiative, but it would be nice to collaborate more on how to structure things. There is already a spec folder in the module/x/gravity module. Lets merge what we can into there and keep the additional docs here. Nit: it would be nice to get some diagrams. |
This patch overhauls the documentation to cover a lot more info and provide a lot more details on different subjects
This clarifies where the 5% number comes from in validator set creation, also notes that this should probably be a parameter.
jkilpatr
force-pushed
the
jkilpatr/more-docs-rebased-2
branch
from
4065bb3 to
438e8c3
Compare
This pr depends on #327 as well as a as of yet unopened pr for validator set rewards.
This dramatically increases the documentation scope as well as adds a top level index for the readme.