Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reference doc format error in "Sample Scenarios" header #360

Closed
michaelmcfadyensky opened this issue Sep 15, 2023 · 4 comments
Closed

Reference doc format error in "Sample Scenarios" header #360

michaelmcfadyensky opened this issue Sep 15, 2023 · 4 comments
Labels
type/documentation A documentation update
Milestone
1.3.22

Comments

@michaelmcfadyensky
Copy link

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
@reactorbot reactorbot added the ❓need-triage This issue needs triage, hasn't been looked at by a team member yet label Sep 15, 2023
@artembilan artembilan added type/documentation A documentation update and removed ❓need-triage This issue needs triage, hasn't been looked at by a team member yet labels Sep 15, 2023
@artembilan artembilan added this to the 1.3.22 milestone Sep 15, 2023
@artembilan
Copy link
Contributor

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

@nikhilkarve
Copy link
Contributor

May I fix this? @artembilan

@artembilan
Copy link
Contributor

Sure thing, @nikhilkarve !

nikhilkarve pushed a commit to nikhilkarve/reactor-kafka that referenced this issue Oct 15, 2023
reactor#360 | Nikhil | Correcting reference doc format error in "Samp…
ec4a3a5 
…le Scenarios" header
@nikhilkarve
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type/documentation A documentation update
Projects
None yet
Milestone
1.3.22
Development

No branches or pull requests
4 participants
@artembilan @michaelmcfadyensky @reactorbot @nikhilkarve