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

Add user guides #989

Merged
merged 1 commit into from
Apr 28, 2024
Merged

Add user guides #989

merged 1 commit into from
Apr 28, 2024

Conversation

ehmicky
Copy link
Collaborator

@ehmicky ehmicky commented Apr 27, 2024

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:

  • Shebangs support on Windows was previously briefly mentioned, but not fully documented.
  • uid/gid options cannot be used on Windows, but this was documented.
  • Null bytes not allowed in the command arguments, and how to work around it.
  • And more.

@ehmicky ehmicky force-pushed the guides branch 7 times, most recently from 5e531fb to db2d1c4 Compare April 28, 2024 17:12
@sindresorhus
Copy link
Owner

Wow! This is really well done and comprehensive. Nice work! I read through it all now and could not really find anything to comment on.

@sindresorhus sindresorhus merged commit be91ecf into main Apr 28, 2024
12 checks passed
@sindresorhus sindresorhus deleted the guides branch April 28, 2024 19:08
@ehmicky
Copy link
Collaborator Author

ehmicky commented Apr 28, 2024

Thanks @sindresorhus, this took many days of work!
I hope this will help with highlighting all the features we offer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants