beyond-all-reason / beyond-all-reason/RecoilEngine

Docs: warning marker isn't interpreted

Open
#3,203 0 comments 0 reactions 0 assignees View on GitHub
area: documentation
Dominant language
C++
Stars
679
Forks
290
Avg merge
3d 2h
Merged PRs (30d)
40

Description

> [!WARNING]
> At some point in the past the marker circled in the below screenshot was interpreted such that the quote below was in a yellow box with a ⚠️ pictogram, like this text. Looks like it broke at some point.

Image

Contributor guide

Open the contributing guide

Research direction

No file or test is named. Start by reproducing the quoted [!WARNING] Markdown example in the project's documentation renderer and trace how admonition markers are handled. Done means the quote renders as a yellow warning box with a warning pictogram, as shown in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.