Doc improvement: Add a short introduction to the Messaging documentation
fgheysels opened this issue · 4 comments
The Arcus Messaging 'Welcome' page in the documentation describes how to install the Messaging library and gives a bullet point list of it's features
However, I think it would be great to add a small 'Introduction' section just before the Installation section.
This Introduction paragraph could describe what Arcus.Messaging is about and why you want to use it. A few sentences would be enough.
I was rather thinking of adding a short description to each (dedicated) readme that is present for each project.
We can add this information to the global welcome page as well, but I think it is good to have it on your 'project landing' page as well.
Well, that's a bit confusing, as the screenshot is about the global welcome page 😄 . Not sure if I understand the 'dedicated' README, as we are linking all to the same README of the project in the root of the repo. As for the 'landing page', you mean on NuGet? Because this README reference is only so that there's something nice to show on NuGet.
The screenshot is for arcus messaging ?
The screenshot is for arcus messaging ?
Yes, I meant the global introduction page of Arcus Messaging, not the README that is present in projects on NuGet.