-
Notifications
You must be signed in to change notification settings - Fork 294
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
chore: copy across cat pool spec from celestia-core #2207
Conversation
|
Codecov Report
@@ Coverage Diff @@
## main #2207 +/- ##
=======================================
Coverage 24.89% 24.89%
=======================================
Files 127 127
Lines 14335 14335
=======================================
Hits 3568 3568
Misses 10400 10400
Partials 367 367 |
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.
LGTM. In the past there was a push for specs to live in the same repo as the code they are relevant to. If we still want that, we can alternatively consider publishing celestia-core specs to their own website so that they don't need to be copied to celestia-app. I'm curious what @adlerjohn thinks.
@@ -7,6 +7,7 @@ | |||
- [Namespace](./specs/namespace.md) | |||
- [Shares](./specs/shares.md) | |||
- [Consensus](./specs/consensus.md) | |||
- [CAT Pool](./specs/cat_pool.md) |
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.
I think we may want to add this to the README here:
celestia-app/specs/src/README.md
Line 7 in 492c3db
- [Consensus](./specs/consensus.md) |
It's a bit ridiculous to maintain 3 locations for the same table of contents so we may consider deleting that README alltogether.
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.
Yeah I added it to the SUMMARY.md
which I think is the main one in terms of the rendered static site
alternatively we could simply link to the catpool spec in core. all that matters imo is that we have a single starting place that at least links to everything. |
I tend to agree that they should live in their own repo but its a bit strange when it comes to forks. I would also prefer that from the outside Celestia is presented as a single cohesive spec |
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.
Looks good! I'd recommend removing the original spec from the cat pool directory and adding a link to this one to avoid having multiple copies.
Update: I see that the cat pool lives in the core repo, so, it may as well make sense to have a separate website dedicated to the core related specs. Though no strong opinion.
Ideally I'd like to have a single site that contains all the specification of the celestia network (including |
(cherry picked from commit f921fbe)
Overview
Given that it is only the specification of celestia-app that is published it makes more sense to include it there rather than in the directory of the cat pool itself
Checklist