Update docs for v5.0
phated opened this issue · comments
We need to update the docs (and publish to website) for the v5 release.
A couple things I noticed during skimming:
- Need to remove the "ordered globs" docs
- Need to update configuration options to vinyl-fs functions
Encoding option added: https://github.com/gulpjs/gulp/blob/master/docs/api/src.md#options
"Explaining Globs" docs have been updated and a section added with an example for ordered globs using ordered-read-stream: https://github.com/gulpjs/gulp/blob/master/docs/getting-started/6-explaining-globs.md#ordered-globs
Encoding option added: https://github.com/gulpjs/gulp/blob/master/docs/api/src.md#options
Which should be classified as a breaking change, when copying binary files (#2790, #2796).
@Sebazzz It was a breaking change - its why we released a new major release, and its in the changelog as a breaking change for that major release.
@Sebazzz It was a breaking change - its why we released a new major release, and its in the changelog as a breaking change for that major release.
Look at it from an end-user perspective:
Default stream encoding to UTF-8
That truly doesn't mean anything to an end user.
@Sebazzz We are working on improving the docs - the website not being updated for v5 was an oversight and we are working on it as we speak. The docs in the repo have been updated on gulp and vinyl-fs but I know people look at the website first. More info here: #2790 (comment)