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

Refactor contract README.md #149

Merged
merged 1 commit into from
Jun 12, 2024
Merged

Conversation

nategraf
Copy link
Contributor

@nategraf nategraf commented Jun 11, 2024

Closes: #108

[groth16-article]: https://www.risczero.com/news/on-chain-verification
[IRiscZeroVerifier]: ./src/IRiscZeroVerifier.sol
Copy link
Contributor

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?

Copy link
Contributor Author

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.

Copy link
Contributor Author

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.

Copy link
Contributor

@pdg744 pdg744 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent! Thanks Victor :)

@pdg744
Copy link
Contributor

pdg744 commented Jun 12, 2024

tagging @sashaaldrick and @nuke-web3 for visibility

@nategraf nategraf merged commit b6dbf11 into main Jun 12, 2024
9 checks passed
@nategraf nategraf deleted the victor/contractrs-readme-refactor branch June 12, 2024 21:17
nategraf added a commit that referenced this pull request Jun 13, 2024
nategraf added a commit that referenced this pull request Jun 17, 2024
Cherry-pick #149 to release-1.0 so that folks following the link from
the dev docs have the latest updates to the docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] correct enumeration of "key contracts"
2 participants