Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 19, 2025

Fixes the GitHub alert syntax in core/bootstrap.md to follow the official GitHub documentation for alerts.

Changes:

  • Placed [!NOTE] on its own line
  • Added an empty blockquote line (>) between [!NOTE] and the content
  • This format matches the official GitHub alert syntax and the pattern used in other files in the repository

Before:

> [!NOTE]
> This documentation is a work in progress...

After:

> [!NOTE]
>
> This documentation is a work in progress...

This format:

  • Follows GitHub's official alert syntax documentation
  • Passes all linters (Prettier, markdownlint, proselint)
  • Matches the pattern used in other files like symfony/debugging.md

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: vinceAmstoutz <46444652+vinceAmstoutz@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix note formatting in core bootstrap fix(core/bootstrap): apply prettier formatting to note block Dec 19, 2025
Copilot AI requested a review from vinceAmstoutz December 19, 2025 15:39
Copy link
Member

@vinceAmstoutz vinceAmstoutz left a comment

Choose a reason for hiding this comment

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


> [!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

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

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.

Co-authored-by: vinceAmstoutz <46444652+vinceAmstoutz@users.noreply.github.com>
Copilot AI changed the title fix(core/bootstrap): apply prettier formatting to note block fix(core/bootstrap): use correct GitHub alert syntax with empty line separator Dec 19, 2025
Copilot AI requested a review from vinceAmstoutz December 19, 2025 15:54
@vinceAmstoutz vinceAmstoutz marked this pull request as ready for review December 19, 2025 15:54
@vinceAmstoutz vinceAmstoutz merged commit 8d86d13 into fix/core-bootstrap-note-formatting Dec 19, 2025
6 checks passed
@vinceAmstoutz vinceAmstoutz deleted the copilot/sub-pr-2235 branch December 19, 2025 15:55
vinceAmstoutz added a commit that referenced this pull request Dec 19, 2025
* fix(core/bootstrap): note formatting

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

* Initial plan

* fix: apply prettier formatting to bootstrap.md

Co-authored-by: vinceAmstoutz <46444652+vinceAmstoutz@users.noreply.github.com>

* fix: use correct GitHub alert syntax with empty line separator

Co-authored-by: vinceAmstoutz <46444652+vinceAmstoutz@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: vinceAmstoutz <46444652+vinceAmstoutz@users.noreply.github.com>

---------

Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants