Skip to content

fix(core/bootstrap): use correct GitHub alert syntax with empty line separator #2236

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

Merged
vinceAmstoutz merged 3 commits into from
Dec 19, 2025
Merged

fix(core/bootstrap): use correct GitHub alert syntax with empty line separator #2236

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
db90710
Initial plan
Copilot Dec 19, 2025
40e0d54
fix: apply prettier formatting to bootstrap.md
Copilot Dec 19, 2025
6e4e398
fix: use correct GitHub alert syntax with empty line separator
Copilot Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions core/bootstrap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
You may want to run a minimal version of API Platform. This one file runs API Platform (without
GraphQL, Eloquent, Doctrine MongoDB...). It requires the following Composer packages:

> [!NOTE]
> This documentation is a work in progress we're working on improving it, in the mean time
> [!NOTE] This documentation is a work in progress we're working on improving it, in the mean time
Copy link
Member

@vinceAmstoutz vinceAmstoutz Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, refer to the official doc:

Alerts

Alerts, also sometimes known as callouts or admonitions, are a Markdown extension based on the blockquote syntax that you can use to emphasize critical information. On GitHub, they are displayed with distinctive colors and icons to indicate the significance of the content.

Use alerts only when they are crucial for user success and limit them to one or two per article to prevent overloading the reader. Additionally, you should avoid placing alerts consecutively. Alerts cannot be nested within other elements.

To add an alert, use a special blockquote line specifying the alert type, followed by the alert information in a standard blockquote. Five types of alerts are available:

Note

Useful information that users should know, even when skimming content.

Tip

Helpful advice for doing things better or more easily.

Important

Key information users need to know to achieve their goal.

Warning

Urgent info that needs immediate user attention to avoid problems.

Caution

Advises about risks or negative outcomes of certain actions.

Suggested change
> [!NOTE] This documentation is a work in progress we're working on improving it, in the mean time
> [!NOTE]
> This documentation is a work in progress we're working on improving it, in the mean time

Copy link
Contributor Author

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 6e4e398. Applied the correct GitHub alert syntax with [!NOTE] on its own line followed by an empty blockquote line, matching the format used in other files like symfony/debugging.md. This passes all linters (Prettier, markdownlint, proselint) and follows the official GitHub alert documentation.

> we declare most of the services manually in the
> [ApiPlatformProvider](https://github.com/api-platform/core/blob/64768a6a5b480e1b8e33c639fb28b27883c69b79/src/Laravel/ApiPlatformProvider.php)
> it can be source of inspiration.
Expand Down