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

Update docs for v5.0 #2764

Open
phated opened this issue Mar 29, 2024 · 7 comments
Open

Update docs for v5.0 #2764

phated opened this issue Mar 29, 2024 · 7 comments
Assignees

Comments

@phated
Copy link
Member

phated commented Mar 29, 2024

We need to update the docs (and publish to website) for the v5 release.

@phated
Copy link
Member Author

phated commented Mar 29, 2024

A couple things I noticed during skimming:

  • Need to remove the "ordered globs" docs
  • Need to update configuration options to vinyl-fs functions

@phated phated pinned this issue Mar 29, 2024
@gulpjs gulpjs deleted a comment from Fa-haxiki Mar 29, 2024
@yocontra
Copy link
Member

yocontra commented Apr 6, 2024

Encoding option added: https://github.com/gulpjs/gulp/blob/master/docs/api/src.md#options

@phated
Copy link
Member Author

phated commented Apr 8, 2024

"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

@Sebazzz
Copy link

Sebazzz commented Apr 18, 2024

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).

@yocontra
Copy link
Member

@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
Copy link

Sebazzz commented Apr 19, 2024

@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.

@yocontra
Copy link
Member

@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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

No branches or pull requests

4 participants