Skip to content

docs: remove space in GitHub-style callout markers [DOCS-680] - #28305

Merged
nickvigilante merged 1 commit into
mainfrom
vigilante/docs-680-remove-the-space-after-in-github-style-callout-markers
Aug 19, 2026
Merged

nickvigilante merged 1 commit into
mainfrom
vigilante/docs-680-remove-the-space-after-in-github-style-callout-markers

Conversation

@nickvigilante

Copy link
Copy Markdown
Contributor

What

Normalize the one GitHub-style callout marker that had a space after ! to the canonical tight form.

  • docs/user-guides/workspace-access/jetbrains/gateway.md: > [! WARNING] -> > [!WARNING]

A full-corpus scan confirmed this was the only spaced marker.

Why

GitHub alerts, the hosted docs (coder.com), and the offlinedocs Fumadocs renderer all require the tight > [!WARNING] form. The spaced form rendered as literal [! WARNING] text instead of a styled alert, so this is a genuine rendering fix on GitHub and coder.com, not an offline-pipeline accommodation.

Surfaced by the offlinedocs Fumadocs migration review (CRF-60 on #27390). Tracked separately from the mixed-case uppercasing fix (DOCS-681), per request.

Linear: DOCS-680

This PR was created with AI assistance (Coder Agents).

GitHub alerts, coder.com, and the offlinedocs Fumadocs renderer require the tight `> [!WARNING]` form. The stray space in `> [! WARNING]` made the marker render as literal text instead of a styled alert.

> This PR was created with AI assistance (Coder Agents).
@linear-code

linear-code Bot commented Aug 19, 2026

Copy link
Copy Markdown

DOCS-680

@github-actions

Copy link
Copy Markdown
Contributor

Docs preview

Check off each page once it's been reviewed. If a page changes in a later push, its checkbox clears automatically so it gets a fresh look. Pages not yet wired into the docs navigation aren't listed here.

@nickvigilante
nickvigilante merged commit e003014 into main Aug 19, 2026
56 of 57 checks passed
@nickvigilante
nickvigilante deleted the vigilante/docs-680-remove-the-space-after-in-github-style-callout-markers branch August 19, 2026 15:48
@github-actions github-actions Bot locked and limited conversation to collaborators Aug 19, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants