Netty User Guide Refers to Chapter 2, Architectural Overview - Does it exist?
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 35.1k
- Forks
- 16.3k
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 143
Description
I originally posted this on Stack Overflow here. It's unclear that this a bug in the documentation.
I was reading the User's Guide for 4.x and in the Getting Started section it reads:
If you prefer top-down approach in learning something, you might want to start from Chapter 2, Architectural Overview and get back here.
I've looked through the other documentation that I could find and don't see anything the seems to match this.
I'm wondering if the document exists? If so, can it be linked into the User's Guide directly? If not, can the User's Guide be updated to indicate that the document is to be written.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by checking the Netty 4.x User's Guide, especially the Getting Started section and its reference to Chapter 2, Architectural Overview. Determine whether that chapter exists in the available documentation; if it does, link it from the User's Guide, and if not, update the reference to explain that it is not yet available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100