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

Add API stability doc link. #1672

Merged
merged 2 commits into from
Mar 12, 2019

Conversation

nventuro
Copy link
Contributor

@nventuro nventuro commented Mar 7, 2019

Do we want to include a longer notice regarding support for different Solidity versions, etc.?

@nventuro nventuro added improvement documentation Inline comments, guides, and examples. labels Mar 7, 2019
@nventuro nventuro added this to the v2.2 milestone Mar 7, 2019
@nventuro nventuro self-assigned this Mar 7, 2019
@nventuro nventuro requested a review from frangio March 7, 2019 20:30
Co-Authored-By: nventuro <[email protected]>
@frangio
Copy link
Contributor

frangio commented Mar 12, 2019

I just realized that this is in the "Install" section. Kind of weird... But I also don't see where else to put it among the current sections. I think I originally envisioned a new section with a list of useful links like: stability, contributing guide, etc. What do you think?

@nventuro
Copy link
Contributor Author

I had the same thoughts as you, but didn't want to revamp the whole readme. A note in the install section regarding stability and listing the different current versions (so that the user can choose which one to install) makes sense imo.

@nventuro nventuro merged commit 29fa0a4 into OpenZeppelin:master Mar 12, 2019
@nventuro nventuro deleted the api-stability-readme branch March 12, 2019 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Inline comments, guides, and examples.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants