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

Remove revision number from top-level README #191

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

lrettig
Copy link
Member

@lrettig lrettig commented May 7, 2019

@axic
Copy link
Member

axic commented May 7, 2019

I'm not sure I understand. It is versioned and this version in the README is the version number.

@axic
Copy link
Member

axic commented May 7, 2019

Last August we've argued that a single version is more readable, hence #146 was merged.

@lrettig
Copy link
Member Author

lrettig commented May 7, 2019

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?

@axic
Copy link
Member

axic commented May 7, 2019

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?

@lrettig
Copy link
Member Author

lrettig commented May 8, 2019

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.

@axic
Copy link
Member

axic commented May 8, 2019

The revision number exists in other files:

Existed before #146 was merged. The only version is in the README.

@lrettig
Copy link
Member Author

lrettig commented May 8, 2019 via email

@lrettig
Copy link
Member Author

lrettig commented May 8, 2019

Existed before #146 was merged. The only version is in the README.

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.

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.

2 participants