Preact-cli: Misleading docs with unpublished package

Created on 14 Jul 2017  路  6Comments  路  Source: preactjs/preact-cli

I feel the docs shouldn't be updated on the master branch till the package is released because it's kinda misleading. I tried the --prerenderUrls option for couple minutes only to find out it wasn't published to npm yet.

All 6 comments

@ooade
Hint: Read the tagged docs if you want to reed the docs for the exact version you are using.
Example with 1.3.0: https://github.com/developit/preact-cli/tree/1.3.0.
BTW npm readme is always matching version api.
BTW in general you install your packages from npm, so this is the default place looking for the readme of the package you intend to use.

Oh, yeah. Looks like we got side-tracked on actually getting a release out! Had a lot of PRs flying in this week. 馃槄

@yavorski IKR. But I guess my issue is pointless since everyone using preact-cli know how to use github well 馃槬

@ooade If they don't know how to use github then why would they look at the master docs instead of the npm-published docs? 馃

Ideally I'd like to have the docs for whatever the current release is hosted elsewhere, perhaps on the Preact website. That seems like a nicer and more official solution to @ooade's concern - I've actually had a few questions about the docs being master VS release recently. It's usually because I'm holding up a release, which I think we can also solve by me not being the gatekeeper for releases haha.

That's better @developit :)

Was this page helpful?
0 / 5 - 0 ratings