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

Minor suggestion for Serve API docs #2169

Closed
scottdotjs opened this issue Apr 8, 2022 · 2 comments · Fixed by #2816
Closed

Minor suggestion for Serve API docs #2169

scottdotjs opened this issue Apr 8, 2022 · 2 comments · Fixed by #2816

Comments

@scottdotjs
Copy link

Looking at the Serve docs explaining a proxy, it would be helpful for learners if there were a couple of links to the Node docs. Not being very experienced with Node, on seeing the example my first reaction was to look for http on npm (very wrong). Then Node's documentation for http didn't make it clear that that HTTPS requires using https instead - I did find it, but only after a bit of poking around.

My suggestions:

Old: "Here's a simple example of a proxy server to get you started."
New: "Here's a simple example of a proxy server to get you started, using Node's http."

Old: "Adding support for HTTPS using your own self-signed certificates"
New: "Adding support for HTTPS using Node's https and your own self-signed certificates"

@evanw
Copy link
Owner

evanw commented Apr 17, 2022

Thanks for the suggestion. I have updated the documentation: https://esbuild.github.io/api/#customizing-server-behavior. I decided to link to node's instructions for setting up a HTTPS server instead of to the https module because it seemed more concise and useful.

@evanw evanw closed this as completed Apr 17, 2022
@scottdotjs
Copy link
Author

Thank you!

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 a pull request may close this issue.

2 participants