Netty: Netty 4.x User Guide - Architectural Overview missing?

[pylight]

Hi,
I'm new to Netty and started reading the 4.x user documentation (since this is the current stable version). In the "Getting Started" section, is stated: "If you prefer top-down approach in learning something, you might want to start from Chapter 2, Architectural Overview and get back here."
Unfortunately there's no second chapter in the documentation? This was pretty confusing for me as a entry point, since basic terms like "channel" don't seem to be described at all.
Maybe this documentation needs to be reworked?

[zhaosoap]

Hi,
I also new in Netty. I prefer to study with partners. We can help each other if you are interested .
You can contact via Wechat . My id is zhaosoap.

Soap

Sent from my iPhone

On Aug 17, 2015, at 14:58, Sven Kammerer [email protected] wrote:

Hi,
I'm new to Netty and started reading the 4.x user documentation (since this is the current stable version). In the "Getting Started" section, is stated: "If you prefer top-down approach in learning something, you might want to start from Chapter 2, Architectural Overview and get back here."
Unfortunately there's no second chapter in the documentation? This was pretty confusing for me as a entry point, since basic terms like "channel" don't seem to be described at all.
Maybe this documentation needs to be reworked?

—
Reply to this email directly or view it on GitHub.

[pieteradejong]

You could start here, even though it's an older version user guide:

http://netty.io/3.5/guide/#architecture

[pylight]

I've bought Netty in action which is from my point of view a very nice starting point. If I didn't had this book I would most probably not have choosen netty as connectivity framework for my software. I think the "free" documentation could be a better, but of course I understand that features/functionality have a higher priority in the project.

[martinandersson]

It's not just the architectural overview that is missing. At the bottom of the 4.1 user guide we read this:

There is more detailed information about Netty in the upcoming chapters.

But there are no links and I haven't been able to find the "upcoming chapters". So they seem to be missing (in addition to the missing architectural overview for Netty 4.x).

Since it has soon been five years since this issue was opened, it's safe to say that the Netty team has no intent of continuing work on the user guide. If that is the case, then I propose the fix is to remove the reference to other non-existing chapters as well as a pointer which package or type JavaDoc I should begin reading as a newcomer. Hopefully pointers from that JavaDoc will lead me forward.

I personally believe JavaDoc and examples in that JavaDoc is all that should be needed with the added benefit that the docs will then be coupled with the source code and therefore becomes the "specification"; something we users can assume will hold true and thus program against versus relying on a piece of word-by-mouth information scoped up from a website. This is also how we know and love the JDK documentation.

Anyways, so far from what I have read, excellent job though! I love the language used and all the jokes. Docs are for people, not machines =)