reference-guide icon indicating copy to clipboard operation
reference-guide copied to clipboard

Configuration API documentation missing

Open sgrimm-sg opened this issue 6 years ago • 3 comments

Axon 3's docs have a section describing the Configuration API, but there seems to be no documentation of that API at all in the Axon 4 version of the documentation.

sgrimm-sg avatar Jul 11 '19 20:07 sgrimm-sg

Thanks for pointing this out @sgrimm-sg. When we updated the framework from Axon 3 to Axon 4, we also did a massive shuffle of all the pages in the Reference Guide for improvements.

Some parts have been merged with others, the Configuration API section being one of them. The idea is that the specific Configuration Block per page specifies how to configure it.

However, I am assuming it doesn't quite so, otherwise you wouldn't have asked for this to come back. We'll look into resolving this, thanks for marking it Steven.

smcvb avatar Jul 12 '19 06:07 smcvb

The docs do contain configuration snippets for the specific components, but what’s missing, as far as I could tell, is any kind of introduction or high-level description of how the configuration API works as a whole, when to call it, and so on.

sgrimm-sg avatar Jul 15 '19 07:07 sgrimm-sg

Thanks for pointing this out Steven, that narrows the feature request down a little. :+1:

smcvb avatar Jul 15 '19 07:07 smcvb