wintercg / proposal-sockets-api

Proposal for an API for establishing TCP connections in Non-Browser JavaScript runtime environments
https://sockets-api.proposal.wintercg.org/
Other
46 stars 2 forks source link

Reorganize Spec for consistency and clarity #8

Closed Ethan-Arrowood closed 10 months ago

Ethan-Arrowood commented 10 months ago

While attempting to fix the problems detailed in #5 I realized that there was a lot of inconsistencies between the usage of markdown and html. Furthermore, the linking was so difficult for me to fix.

This PR is a rewrite/reorganization of the spec that follows patterns I see in the Streams and Fetch specs. It strictly uses HTML elements instead of markdown. It also attempts to reorganize the information in such a way that allows for easier linking, and ideally improved readability.

Still some minor things to fix up. But wanted to share so we can start reviewing asap.

🚀

Ethan-Arrowood commented 10 months ago

Thank you for the review! I'm going to merge this now and then we can iterate on some of the other pieces in follow up PRs.

Things to revisit: