Skip to content

docs: align callout names with GitHub alerts#242

Merged
johnleider merged 1 commit into
masterfrom
worktree-github-callout-alignment
May 23, 2026
Merged

docs: align callout names with GitHub alerts#242
johnleider merged 1 commit into
masterfrom
worktree-github-callout-alignment

Conversation

@johnleider
Copy link
Copy Markdown
Member

Summary

  • Rename callout types: infonote, errorcaution
  • Add important callout (uses accent color)
  • Move askai from accent to secondary
  • Migrate 11 docs pages from [!INFO] to [!NOTE]
  • Update Callouts demo section in using-the-docs.md with new types

GitHub-aligned syntax now matches: TIP, NOTE, WARNING, CAUTION, IMPORTANT. v0-specific ASKAI, DISCORD, TOUR preserved.

Test plan

  • pnpm lint:fix clean
  • pnpm typecheck clean
  • pnpm build:docs succeeds (284 pages rendered)
  • Spot-checked rendered HTML: Note uses bg-info-10 (blue), Tip uses bg-success-10 (green)
  • pnpm repo:check clean (knip + sherif)

Rename `info` → `note` and `error` → `caution`, add `important`
(uses accent color). Move `askai` to secondary. Migrate 11 pages
from `[!INFO]` to `[!NOTE]`.
@johnleider johnleider merged commit 45745fb into master May 23, 2026
5 checks passed
@johnleider johnleider deleted the worktree-github-callout-alignment branch May 23, 2026 16:10
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.

1 participant