docs: warn that README contains newest features

[nfischer]

Might be a good idea, in light of #405 and #406

[ariporad]

Actually, we don't own shelljs.org, and documentup is generated from master.

[nfischer]

Shelljs.org redirects to documentup, right? And documentup is only generated when we actually generate it, which is usually once per release. Npm is pretty reliable though, and there's no way that its docs would be wrong.

[ariporad]

Hmm... I didn't know it did that. TIL.

[ariporad]

LGTM! But could you rebase?

[nfischer]

@ariporad If we switch to a dev branch like you suggested, it would probably cleaner to just close this. That way docs would not get updated with new features until the next release.

If we find an error with the docs (maybe something is confusing or incomplete), we can merge that into master sooner and rebase dev off of master.

[ariporad]

SGTM

[ariporad]

@nfischer: One problem with this is that we would push the notice to npm, which wouldn't make much sense.

[nfischer]

@ariporad What do you mean by the latest notice? Not quite following you.

[ariporad]

If we add a notice that the README is the dev version, then when we push
the README to npm, the notice will be included. Which doesn't make much
sense.

Ari

On Mon, Apr 25, 2016 at 5:17 PM, Nate Fischer notifications@github.com
wrote:

@ariporad https://github.com/ariporad What do you mean by the latest
notice? Not quite following you.

—
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#410 (comment)

[nfischer]

I see your point. This notice isn't intended to say so much as "these docs are out of date, don't trust them," but more as "regardless of whether you're at Github or npm, the latest features are at Github and the most-recent-release docs are at npm." If there's a way to better phrase that, let's do it.

[ariporad]

KK. LGTM!