Improve Messaging documentation
fgheysels opened this issue · 2 comments
When you go to the documentation page of Arcus Messaging, this is what you see:
We're talking about how to install it, and what the features are, but I'm missing a global 'What is this / Why should i use this' section. I'd like to have a short introduction section which describes what this project is for, and why you could use it, and that section should be the very first section (before 'Installation').
It could have content like this:
Introduction
Arcus.Messaging provides functionality to easily create message based solutions. Arcus.Messaging allows you to focus on writing the business logic that is required to handle received messages, while Arcus takes care of all the infrastructural plumbinb code.
Actually, I don't know if I would put the 'Features' and 'Guides' section on the home page as well, since we have this already in the menu on the left side.
Also, I think it would be good to re-order the Message-pums features section:
I would put them in this order:
- Azure Service Bus Message pump
- Azure Service Bus Messag pump for Azure Functions
- Customize message pumps
Before we refactor this, please look at the PR that already does focus on the message handling #268 , this isn't shown yet bc it's in preview. The focus is now on message handling instead of on pumps. Please check the merged PR before this.
The introduction page, sure, that can be improved. 👍
See the preview of that PR: https://deploy-preview-268--arcus-messaging.netlify.app/next/ the conclusion was indeed that the structure is now better, but there's missing an introduction.
Aha, we already added an introduction in #280.