-
Notifications
You must be signed in to change notification settings - Fork 43
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
Refactor contract README.md #149
Conversation
[groth16-article]: https://www.risczero.com/news/on-chain-verification | ||
[IRiscZeroVerifier]: ./src/IRiscZeroVerifier.sol |
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.
question: mb this should point to a tagged release?
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.
It points locally because they are viewing this on a given git ref. If they are on main
, they'll expect this link to take them to the implementation on main
, and if you are interested in the released version they should open this README on that branch instead.
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.
When/if we link to this file from the docs, we should link toa tagged release.
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.
Excellent! Thanks Victor :)
tagging @sashaaldrick and @nuke-web3 for visibility |
Closes: #108