Skip to content
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

Move and link specs #15

Closed
4 tasks
cmwaters opened this issue Jan 10, 2024 · 4 comments
Closed
4 tasks

Move and link specs #15

cmwaters opened this issue Jan 10, 2024 · 4 comments
Assignees

Comments

@cmwaters
Copy link
Collaborator

cmwaters commented Jan 10, 2024

Summary

Currently the specs for these packages are still located on the celestia-app repo. For coherence, we should either move them here and add appropriate links on celestia-app or update the links to the specs in this repo

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@rootulp
Copy link
Collaborator

rootulp commented Jan 17, 2024

I think we should think about the desired end-state before tackling this issue. One possible end-state that I like:

  1. All specs hosted at https://celestiaorg.github.io/celestia-app/
  2. The spec for a component lives in the same repo as the code that implements that component

@cmwaters
Copy link
Collaborator Author

Yes in my ideal world, all specs are compiled together and hosted in a domain like https://specs.celestia.org with each repo containing the specs that are relevant to them

@rootulp
Copy link
Collaborator

rootulp commented Jan 21, 2024

Agreed but I think the ideal approach may be a bit cumbersome to implement because it would involve syncing the specs from this repo to celestia-app and then publishing. I think the easiest path to close this issue is:

In this repo

  1. Update this link to point to https://celestiaorg.github.io/celestia-app/specs/shares.html
  2. Update this link to point to https://celestiaorg.github.io/celestia-app/specs/namespace.html

There aren't READMEs for square, inclusion, or blob.

In celestia-app

  1. Update this link to point to this repo
  2. Update this link to point to this repo.

The specs for https://celestiaorg.github.io/celestia-app/specs/data_square_layout.html#data-square-layout don't appear to link to the implementation that moved so I think that's it.

@rootulp rootulp self-assigned this Jan 21, 2024
rootulp added a commit to celestiaorg/celestia-app that referenced this issue Feb 6, 2024
@rootulp
Copy link
Collaborator

rootulp commented Feb 19, 2024

Closed by PRs mentioned above.

@rootulp rootulp closed this as completed Feb 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants