-
Notifications
You must be signed in to change notification settings - Fork 165
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
Indicate stability #95
Comments
What kind of indication do you think would be helpful? I guess I've always thought of specs as somewhat stable things inherently, although now that you mention it, the distinction between the various W3C spec stages (editor's draft, candidate recommendation, recommendation, etc.) does kind of give this. |
@ForbesLindesay do you have some simple examples of what you're thinking here? Are you thinking we should somehow indicate that the version of the spec that someone sees when they land on the repo README vs. the one deployed via github pages may be different? Or something else? |
I think it would be nice to indicate that the version in the readme is not always stable. I was more thinking that we should indicate on the web-page version that |
Yeah, I think it's a good idea to indicate that master README isn't necessarily the officially released version, and that people should look at github pages. If we can handle/phrase that in a way that allows us not to have to re-edit the spec every time we push to github pages, that would be ideal! To some degree, semantic versioning implies the stability of |
My impression is that although we all know it's really stable, and that it's made by people who understand how semver works, many other people might not. |
At this point I think we want a concrete idea of what such text would look like :). My first idea is to add a very short sentence in the intro text per #106. Or, we could relegate it to a sub-page like the change log. (Note that sub-pages will get a lot more prominence in my redesign of gh-pages for 1.1, since we need to link to differences from Promises/A, change log, and implementations at the very least.) |
A first stab at such text: "The It feels a bit long, but I wanted something that's hopefully easy to understand without any specific background knowledge. |
I think we should add an indication of stability to the website. I think this specific spec is pretty stable (or rather will be once 1.1 is ratified in #84) and it would be really good to indicate that.
The text was updated successfully, but these errors were encountered: