reactor/reactor-kafka

Reference doc format error in "Sample Scenarios" header

michaelmcfadyensky opened this issue · 4 comments

Documentation Issue

On the reference documentation, there is a formatting error in the section header for Sample Scenarios. The text on the web page shows up as == Sample Scenarios. I believe == is used in ascii docs for denoting a section header.

I've attached a screenshot showing the issue.

Improvement Suggestion

Ensure the section header format is applied correctly.

Additional context

Screenshot 2023-09-15 at 12 24 35

That one has to be as a section title.
Please, consider to provide a fix with a PR where you would just add a blank line before that == Sample Scenarios one.
Thanks

May I fix this? @artembilan

Sure thing, @nikhilkarve !

@artembilan Corrected that, can you take a look whenever you are available?
#362