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

Documentation for Got 12 #1699

Merged
merged 10 commits into from
Jul 13, 2021
Merged

Documentation for Got 12 #1699

merged 10 commits into from
Jul 13, 2021

Conversation

szmarczak
Copy link
Collaborator

@szmarczak szmarczak commented Apr 27, 2021

https://github.com/sindresorhus/got/tree/docs-v12#documentation

Fixes #1405

TODO (the below will be another PR):

  • update TypeScript docs
  • Node.js migration guide
  • Axios migration guide

Checklist

  • I have read the documentation.
  • I have included a pull request description of my changes.
  • I have included some tests.
  • If it's a new feature, I have included documentation updates in both the README and the types.

@sindresorhus
Copy link
Owner

I think we should preserve the initial usage example in the readme, so users can quickly see how easy Got is: https://github.com/sindresorhus/got#usage (JSON and Promise examples)

@sindresorhus

This comment has been minimized.

@szmarczak

This comment has been minimized.

@szmarczak szmarczak changed the title [WIP] Documentation for Got 12 Documentation for Got 12 Jul 10, 2021
@szmarczak szmarczak marked this pull request as ready for review July 10, 2021 20:16
@szmarczak

This comment has been minimized.

@sindresorhus
Copy link
Owner

@szmarczak Are you done with the docs? If so, I think it's easier to just merge it in and then I can do a look over and fix typos and stuff. It's faster for me to just fix things directly than to comment on things here.

@sindresorhus
Copy link
Owner

TODO (the below will be another PR):

Can you open an issue so we don't forget?

@szmarczak
Copy link
Collaborator Author

Are you done with the docs?

Yes.

Can you open an issue so we don't forget?

Sure.

@szmarczak
Copy link
Collaborator Author

#1684 (comment)

@szmarczak szmarczak merged commit 1a97dc0 into main Jul 13, 2021
@szmarczak szmarczak deleted the docs-v12 branch July 13, 2021 15:42
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.

Document stream.options
2 participants