This is a complete rewrite of our API Documentation for gulp 4. We'd really appreciate some thorough review - as we've stared at these for months.
A few things to note:
- Each API is in it's own document because things were really unwieldy with a single doc previously
- Tables are used extensively to pack a lot of data densely but still be readable.
- API Concepts was created because we had a lot of terminology that kept needing to be defined or linked - I don't believe it is complete but added the things I could come up with.
- Everything should be completely updated for the shipped 4.0 - If not, that's a mistake that should be reported.
- Not all error cases/messages are documented, especially for
src()/dest()because they touch the filesystem and might error in untested ways based on a user's filesytem/configuration. - We pulled in all the external docs we could hunt down and rewrote them to match our style - so you'll see massive tables of options for
src()andwatch()and maybe some others.
I'll comment inline with a few other questions we had on specific parts.
cc @stevelacy @contra @terinjokes @callumacrae @jonschlinkert @doowb @erikkemperman