chore: move NMT spec #1559
Merged
chore: move NMT spec #1559
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
the
chore
rootulp
requested review from
evan-forbes,
liamsi,
adlerjohn and
MSevey
as code owners
MSevey
requested review from
a team and
evan-forbes
and removed request for
a team
staheri14
approved these changes
Mar 29, 2023
There was a problem hiding this comment.
The proposed change seems to align with how other documentation is organized in this repository. However, (as a general comment) it is a bit confusing to locate specific documentation since we also have a specs folder. It would be helpful to provide guidance in the repository's main README file on how docs/specs are organized.
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.
This PR moves the NMT spec to the place I expected it to be. I was looking for it in
pkg/wrapper/*because other packages have docs (or specs) in the root of the directory (e.g. https://github.com/celestiaorg/celestia-app/tree/main/x/blob and https://github.com/celestiaorg/celestia-app/tree/main/x/blob).An alternative to this PR: we could move the existing file into the specs book