Files

1.3 KiB

Formatting rules for user-facing reference files

These rules apply to all .md files the user may view on mobile (Telegram preview, file open, email attachment).

ASCII-only status indicators

Do NOT use emoji for status indicators in files the user reads. Common mobile viewers misinterpret UTF-8 emoji sequences as Latin-1 characters, producing garbled text like 🔴 instead of :red_circle:.

Use these replacements instead:

  • 🔴 -> [HIGH]
  • 🟡 -> [MED] or [WARN]
  • 🟢 -> [OK] or [LOW]
  • :check_mark_button: -> [OK]
  • :check_mark: -> [OK]
  • :cross_mark: -> [FAIL]
  • 🌐 -> [INFO]
  • 🌀 -> [PENDING]
  • :right_arrow: -> ->
  • em dash -- -> --
  • times sign x -> x

No pipe tables in summaries

Markdown pipe tables (| col | col |) are unreadable on small phone screens. Use bullet lists or comma-separated inline format instead:

Bad:

| ID | Issue | Status |
|----|-------|--------|
| 1  | Caddyfile | Fixed |

Good:

Fixed:
- 1 Caddyfile -> Fixed
- 2 Backups -> Fixed

Keep it pure ASCII

Any non-ASCII character is a risk. Stick to [0-9A-Za-z], hyphens, underscores, periods, and standard punctuation. Smart quotes, long dashes, mathematical symbols, and Unicode arrows all break on some mobile renderers.