Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds user guides.
This groups Execa features into sections, pages and groups of pages, which helps understanding those features. In a way, it is similar to the documentation approach taken by some of your other bigger projects like AVA and got.
The user guides are ordered, so they can be used as a user manual, reading one user guide at a time.
The user guides include many examples and add more details and context to each feature's documentation. The API reference points to those additional details, which allows that API reference to be smaller and less overwhelming.
Some features which failed to be properly documented are also covered by this PR. For example:
uid
/gid
options cannot be used on Windows, but this was documented.