Skip to content

Ensure alignment between query chapter flow with event chapter flow #4058

Description

@smcvb

Suggested Documentation change

The event chapter of the reference guide has seen the highest amount of attention during #3961.
We're confident that the flow of the pages and sections there is beneficial for the query chapter too.

Hence, it would be good to validate if both align sufficiently so.
If the query chapter deviates, we should adjust it such that it aligns.

Pointers to take note of when validating and ensuring the alignment are:

  1. The index.adoc contains a short intro paragraph, a list of topic-specific terms with one liner description, and and overview of that chapter. And nothing more.
  2. The handlers.adoc provides an introduction explaining handlers and handling components, a section on how to register handlers, a section on how handlers are resolved to send a message to, and an explanation about handler return types.
  3. The dispatchers.adoc provides an introduction explaining the logic spots to dispatch from, the available infrastructure to dispatch with and explanation + examples when and how to use these.
  4. The infrastructure.adoc provides a short intro listing all infracomponents, and each of these components is given an explanation when they're valuable.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Priority 3: CouldLow priority. Issues that are nice to have but have a straightforward workaround.

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions