docs: update shares specs #1880
Merged
Conversation
This file contains 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
rootulp
added
documentation
|
rootulp
requested review from
liamsi,
adlerjohn,
MSevey,
evan-forbes and
cmwaters
as code owners
This comment was marked as resolved.
This comment was marked as resolved.
evan-forbes
previously approved these changes
Jun 6, 2023
There was a problem hiding this comment.
overall really good!! I think we might be able to add a sentence or two in places that would help provide more context to readers less familar with the rest of celestia. besides that only had a few questions and mostly non-blocking discussions
will also take a second look after chewing on it, but am approving
|
@staheri14 yep you can click this link https://celestiaorg.github.io/celestia-app/pr-preview/pr-1880/specs/shares.html which you can get to via 
|
Codecov Report
@@ Coverage Diff @@
## main celestiaorg/celestia-app#1880 +/- ##
==========================================
- Coverage 21.22% 21.21% -0.02%
==========================================
Files 120 121 +1
Lines 13697 13704 +7
==========================================
Hits 2907 2907
- Misses 10500 10509 +9
+ Partials 290 288 -2
|
staheri14
reviewed
Jun 6, 2023
There was a problem hiding this comment.
Thanks a lot for your great work on this PR. I've added some comments and ideas about how we structure the spec and organize the content. Some of my suggestions aren't just for this PR—they'll apply to all our future specs too, since this is our first spec PR, it's ended up with all these comments.
evan-forbes
previously approved these changes
Jun 15, 2023
cmwaters
previously approved these changes
Jun 16, 2023
evan-forbes
approved these changes
Jun 16, 2023
staheri14
approved these changes
Jun 16, 2023
evan-forbes
pushed a commit
that referenced
this pull request
Jul 3, 2023
* docs: extract shares page * ignore generated .html files * rename figures * update diagrams * update reserved bytes * fix: broken links * link to reserved namespace and x/blob * extract common padding specs * update parity section * overview -> abstract * add link to NMT spec * link to block * add Glossary * clarify Celestia state * move blob data to glossary * nit: use may * remove data withholding attack * draft: overview * nit: may -> MAY * move terms up and fill out overview * adopt more of template * Improve share sequence term * fill out share splitting * fix links * add note to clarify blob * add references section * Update specs/src/specs/shares.md Co-authored-by: Sanaz Taheri <[email protected]> * Update specs/src/specs/shares.md Co-authored-by: Sanaz Taheri <[email protected]> * add figure numbers * clarify share sequence length * blob -> transaction * denote field in diagram * remove duplicate portion of transaction shares * clarify share size * fix: lint b/c non-interactive => blob share commitment --------- Co-authored-by: Sanaz Taheri <[email protected]>
evan-forbes
pushed a commit
that referenced
this pull request
Jul 3, 2023
* docs: extract shares page * ignore generated .html files * rename figures * update diagrams * update reserved bytes * fix: broken links * link to reserved namespace and x/blob * extract common padding specs * update parity section * overview -> abstract * add link to NMT spec * link to block * add Glossary * clarify Celestia state * move blob data to glossary * nit: use may * remove data withholding attack * draft: overview * nit: may -> MAY * move terms up and fill out overview * adopt more of template * Improve share sequence term * fill out share splitting * fix links * add note to clarify blob * add references section * Update specs/src/specs/shares.md Co-authored-by: Sanaz Taheri <[email protected]> * Update specs/src/specs/shares.md Co-authored-by: Sanaz Taheri <[email protected]> * add figure numbers * clarify share sequence length * blob -> transaction * denote field in diagram * remove duplicate portion of transaction shares * clarify share size * fix: lint b/c non-interactive => blob share commitment --------- Co-authored-by: Sanaz Taheri <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #1855, #1882
Opens celestiaorg/go-square#30, celestiaorg/go-square#38