You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Node.js Undici is a high-performance HTTP/1.1 client with connection pooling, KeepAlive, and more, providing a low-level HTTP client API. However, its documentation lacks completeness, clarity, and examples, which makes it challenging for developers to understand and utilize the full potential of Undici effectively.
46
+
47
+
#### How would we measure success?
48
+
Success can be measured by:
49
+
- Improved documentation completeness, covering all aspects of Undici's functionality.
50
+
- Enhanced clarity, ensuring that developers can easily understand the concepts and usage of Undici.
51
+
- Increased usage and adoption of Undici due to improved documentation quality.
52
+
- Positive feedback and reduced queries related to Undici usage on community forums and GitHub issues.
53
+
54
+
#### What skills would a technical writer need to work on this project?
55
+
- Proficiency in understanding technical concepts related to HTTP/1.1 clients, connection pooling, KeepAlive, and related networking topics.
56
+
- Ability to translate complex technical information into clear and concise documentation suitable for developers of varying skill levels.
57
+
- Experience writing code examples and tutorials for Node.js/JavaScript.
58
+
- Familiarity with Markdown for documentation formatting.
59
+
- Strong communication skills to collaborate with developers, gather feedback, and iterate on documentation improvements.
60
+
61
+
#### Expected outcomes:
62
+
63
+
***Must Have**
64
+
- Comprehensive documentation covering Undici's features, including detailed explanations and usage examples.
65
+
- Clear and concise API reference documentation.
66
+
- Tutorials and guides for common Undici usage scenarios.
67
+
- Improved organization and navigation within the documentation to enhance usability.
68
+
69
+
***Nice To Have**
70
+
- Contributions to Undici's official website for seamless integration of the updated documentation.
71
+
- Interactive examples or demos showcasing Undici's capabilities.
72
+
- Better/Newer website (e.g. Docusaurus or Next.js based)
73
+
74
+
#### Volunteers / Mentors
75
+
- Lead Mentor: [Matteo Collina](https://github.com/mcollina)
For inquiries or to express interest in contributing, please reach out to hello AT matteocollina.com. You can also join the Node.js Undici community on GitHub or the OpenJS Slack for discussions and support.
0 commit comments