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.

Sign up for GitHub

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

Undici docs project #1249

Merged
merged 2 commits into from
Feb 28, 2024
Merged

Undici docs project #1249

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28f4e7d
Undici docs project
mcollina Feb 12, 2024
f1861ad
Update mentorship/2024/google-season-of-docs/README.md
mcollina Feb 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions mentorship/2024/google-season-of-docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,50 @@ If you would like to submit a proposal for an initiative that you would like to

```


## Projects

### Project Idea: Node.js Undici Documentation Improvement

#### Problem
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.

#### How would we measure success?
Success can be measured by:
- Improved documentation completeness, covering all aspects of Undici's functionality.
- Enhanced clarity, ensuring that developers can easily understand the concepts and usage of Undici.
- Increased usage and adoption of Undici due to improved documentation quality.
- Positive feedback and reduced queries related to Undici usage on community forums and GitHub issues.

#### What skills would a technical writer need to work on this project?
- Proficiency in understanding technical concepts related to HTTP/1.1 clients, connection pooling, KeepAlive, and related networking topics.
- Ability to translate complex technical information into clear and concise documentation suitable for developers of varying skill levels.
- Experience writing code examples and tutorials for Node.js/JavaScript.
- Familiarity with Markdown for documentation formatting.
- Strong communication skills to collaborate with developers, gather feedback, and iterate on documentation improvements.

#### Expected outcomes:

* **Must Have**
- Comprehensive documentation covering Undici's features, including detailed explanations and usage examples.
- Clear and concise API reference documentation.
- Tutorials and guides for common Undici usage scenarios.
- Improved organization and navigation within the documentation to enhance usability.

* **Nice To Have**
- Contributions to Undici's official website for seamless integration of the updated documentation.
- Interactive examples or demos showcasing Undici's capabilities.
- Better/Newer website (e.g. Docusaurus or Next.js based)

#### Volunteers / Mentors
- Lead Mentor: [Matteo Collina](https://github.com/mcollina)
- Co-Mentor: [Ethan Arrowood](https://github.com/ethan-arrowood)

#### Contact info
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.

```

---

## Resources
Expand Down