-
Notifications
You must be signed in to change notification settings - Fork 126
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
Remove revision number from top-level README #191
base: master
Are you sure you want to change the base?
Conversation
Nothing in this doc is versioned and it's confusing to lead with this. Let's just version the actual specification docs (https://github.com/ewasm/design/blob/master/contract_interface.md, https://github.com/ewasm/design/blob/master/eth_interface.md, https://github.com/ewasm/design/blob/master/system_contracts.md).
I'm not sure I understand. It is versioned and this version in the README is the version number. |
Last August we've argued that a single version is more readable, hence #146 was merged. |
I'm approaching this from a readability perspective. For someone landing on this page trying to learn about Ewasm, it's confusing that the very first thing they see is a version number. What in this doc specifically (README.md) depends on the version number? |
Is removing a version number entirely from the repository a good approach? Is that version number line the biggest issue with the README right now? |
The revision number exists in other files: 69b3e41#diff-04c6e90faac2675aa89e2176d2eec7d8. I don't see why it belongs in this file. I'm tackling other README stuff in #192. |
Existed before #146 was merged. The only version is in the README. |
well, that's a problem :)
|
Add a separate revision file
Sorry I missed this fact originally. I created a separate revision file. @axic is this better? Honestly, the real issue here is that this repo presently serves two different purposes: containing the spec itself, and containing high-level documentation on Ewasm. Just trying to draw a line and be a bit more explicit about this. |
Nothing in this doc is versioned and it's confusing to lead with this. Let's just version the actual specification docs (https://github.com/ewasm/design/blob/master/contract_interface.md, https://github.com/ewasm/design/blob/master/eth_interface.md, https://github.com/ewasm/design/blob/master/system_contracts.md).