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

pull in external docs #1281

Closed
5 tasks done
yocontra opened this issue Sep 25, 2015 · 6 comments
Closed
5 tasks done

pull in external docs #1281

yocontra opened this issue Sep 25, 2015 · 6 comments

Comments

@yocontra
Copy link
Member

yocontra commented Sep 25, 2015

right now all of the docs are scattered amongst sub-repos, and our main repo just links to them. this is really really shitty and makes it difficult to know where to file issues and difficult to find documentation.

repos that need to be pulled in:

  • vinyl-fs (for .src, .dest, and .symlink)
    • vinyl (for what files coming out of .src and .dest look like)
    • glob-stream (for .src)
  • chokidar (for .watch)
  • undertaker
@es128
Copy link
Contributor

es128 commented Sep 25, 2015

Ok. Let me see if I can help with the chokidar stuff tonight.

@phated
Copy link
Member

phated commented Nov 9, 2015

Looking for some more people to contribute on the remaining items in this list.

@troch
Copy link

troch commented Nov 14, 2015

I thought I had commented on this, must have forgotten to click "Comment"... Looking at API.md on 4.0 branch, undertaker is referenced and its methods (task, lastRun, series, parallel) seem to have up-to-date documentation, but they are scattered. Should those API functions be grouped together, API.md split into smaller files, have a main file describing Gulp's main dependencies making its API...?

@Romanx
Copy link

Romanx commented Nov 16, 2015

I'll take a look at those that aren't pulled in and make a PR

@phated
Copy link
Member

phated commented Dec 23, 2015

Ref #1446

@phated
Copy link
Member

phated commented Oct 25, 2018

The projects listed (and even more) have been incorporated into our API Docs rewrite so I'm going to close this.

Note: We brought them all in by hand so they'll have to be kept up-to-date manually. That being said, most are controlled by us or don't change very often.

@phated phated closed this as completed Oct 25, 2018
@phated phated moved this from Docs to Done in v4 Dec 7, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
v4
  
Done
Development

No branches or pull requests

5 participants