DotNetty icon indicating copy to clipboard operation
DotNetty copied to clipboard

Documentation

Open mstrother opened this issue 7 years ago • 8 comments

I moved a project from a 'roll your own' socket solution to DotNetty. The performance increase blew me away. Netty's Java documentation helped but it would have be useful to have native documentation. What did help a bit was the documentation and code for the Azure-IoT-Protocol gateway. This page, has a section called Component Structure (Core DotNetty Components) which runs down the basic architecture of DotNetty. That would be useful, almost verbatim, in the DotNetty README.md. It would have got me up to speed faster. It could serve as a starting ground for future, more in depth, documentation.

Is there any support on adding that text, and perhaps some direct links to the Netty project documentation, to the DotNetty README.md? I'd be willing to take it on. It would be a quick task.

mstrother avatar Mar 20 '17 23:03 mstrother

Dotnetty really need a documentation , I rely on reading java netty documents and reading dotnetty source code to learn this framework. Not a good experience.

Just do it~ Cheers~

me66ccff avatar May 27 '17 15:05 me66ccff

@me66ccff the wiki page is open :D

StormHub avatar May 29 '17 10:05 StormHub

Dotnetty really need a documentation +++

introspection3 avatar Mar 06 '19 07:03 introspection3

Yes this is +1 from me as well. It's all good saying read the netty docs like here

https://github.com/Azure/DotNetty/issues/135#issuecomment-228128385

but that really isn't applicable apart from high level concepts.

nshCore avatar Mar 09 '19 23:03 nshCore

Yes please!

monsieurleberre avatar Apr 16 '19 09:04 monsieurleberre

yes please

Kasperki avatar May 02 '19 18:05 Kasperki

DotNet has been prejudiced by Javaer for too many years,Now we must have a document to develop high performence soft ware...

introspection3 avatar May 03 '19 01:05 introspection3

Don't expect many people to use this library without any documentation or "Quickstart"

bugproof avatar Jul 26 '19 11:07 bugproof