add crate with jet documentation#38
Draft
gerau wants to merge 2 commits intoBlockstreamResearch:mainfrom
Draft
Conversation
gerau
force-pushed
the
feat/jet-documentation
branch
from
cd1572e to
f510493
Compare
This adds documentation for jets in form of crate, so we could import that into LSP. Also adds binary to generate `jets.json` with correct types, defined in SimplicityHL repo.
gerau
force-pushed
the
feat/jet-documentation
branch
from
f510493 to
ab0365c
Compare
Contributor
Author
|
I had moved jets documentation and section info to rust code, and also add simple CLI to generate |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 adds documentation for jets in the form of a crate, so that we can import it into the LSP.
This crate is better suited here than in SimplicityHL because all updates to the documentation will be in one repository.
Not sure how is better -- when we have crate in its own directory or have
Cargo.tomlat root level, would be happy to move it if needed.