Azure / Azure/DotNetty

Documentation

Open
#213 8 comments 13 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
4.3k
Forks
1k
PR merge metrics
No merged PRs in 30d

Description

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](https://github.com/Azure/azure-iot-protocol-gateway/blob/master/docs/DeveloperGuide.md), 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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.