search

Azure / DotNetty

DotNetty project – a port of netty, event-driven asynchronous network application framework
Other
4.09k stars 977 forks source link

Documentation #213

Open mstrother opened 7 years ago

mstrother commented 7 years ago

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.

me66ccff commented 7 years ago

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~

StormHub commented 7 years ago

@me66ccff the wiki page is open :D

introspection3 commented 5 years ago

Dotnetty really need a documentation +++

nshCore commented 5 years ago

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.

monsieurleberre commented 5 years ago

Yes please!

Kasperki commented 5 years ago

yes please

introspection3 commented 5 years ago

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

bugproof commented 5 years ago

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