docs: uppercase mixed-case GitHub-style callout markers [DOCS-681] - #28304
Merged
nickvigilante merged 1 commit intoAug 19, 2026
Conversation
GitHub alerts, coder.com, and the offlinedocs Fumadocs renderer require all-caps alert types. Mixed-case markers rendered as literal text instead of styled alerts: - docs/install/rancher.md: [!Important] -> [!IMPORTANT] - docs/user-guides/shared-workspaces.md: [!Important] -> [!IMPORTANT] - docs/user-guides/workspace-access/index.md: [!Note] -> [!NOTE] > This PR was created with AI assistance (Coder Agents).
Contributor
Docs previewCheck 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. |
BobbyHo
approved these changes
Aug 19, 2026
nickvigilante
deleted the
vigilante/docs-681-uppercase-mixed-case-github-style-callout-markers-across
branch
August 19, 2026 15:48
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Uppercase the mixed-case GitHub-style callout markers in the docs corpus to the canonical all-caps form.
docs/install/rancher.md:> [!Important]->> [!IMPORTANT]docs/user-guides/shared-workspaces.md:> [!Important]->> [!IMPORTANT]docs/user-guides/workspace-access/index.md:> [!Note]->> [!NOTE]A full-corpus scan confirmed these were the only mixed-case markers.
Why
GitHub alerts, the hosted docs (coder.com), and the offlinedocs Fumadocs renderer all require all-caps alert types (
[!NOTE],[!IMPORTANT], and so on). The mixed-case form rendered as literal text instead of a styled alert (on some pages directly next to a correctly-rendered all-caps 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 space-after-
!fix (DOCS-680), per request.Linear: DOCS-681