Skip to content
New issue

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

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

Already on GitHub? # to your account

[Core > getting started] Remove empty block quote #2022

Conversation

vinceAmstoutz
Copy link
Contributor

Removed an unnecessary empty block in the "CAUTION" section of the documentation. This change cleans up the formatting and ensures the documentation is more readable and concise.

While fixing this I realized that the rendering is not very nice on the doc site @dunglas.

Expected rendering (with the actual code):
image

But in the documentation website we have this rendering:
image

Removed an unnecessary empty block in the "CAUTION" section of the documentation. This change cleans up the formatting and ensures the documentation is more readable and concise.
@dunglas dunglas merged commit 5801e18 into api-platform:4.0 Oct 1, 2024
1 check passed
@vinceAmstoutz vinceAmstoutz deleted the docs-improve-getting-started-with-better-caution-warning-message branch October 1, 2024 09:50
@dunglas
Copy link
Member

dunglas commented Oct 1, 2024

Let's merge this for now, but this looks like a bug on the MD parser of the site. IIRC the syntax with an empty line is a best practice.

@vinceAmstoutz
Copy link
Contributor Author

Any ideas on how to improve this? Should be modified on api-platform/docs-website no?

@dunglas
Copy link
Member

dunglas commented Oct 1, 2024

Likely, yes.

@vinceAmstoutz
Copy link
Contributor Author

I've created an issue for this issue here: api-platform/docs-website#13

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants