Skip to content

Comments

fix: Remove emoji characters from JSON/JSON5 code blocks and add documentation standards#149

Merged
chipkent merged 6 commits intomainfrom
copilot/fix-non-utf8-characters-json
Feb 12, 2026
Merged

fix: Remove emoji characters from JSON/JSON5 code blocks and add documentation standards#149
chipkent merged 6 commits intomainfrom
copilot/fix-non-utf8-characters-json

Conversation

Copy link
Contributor

Copilot AI commented Feb 12, 2026

JSON/JSON5 code blocks in README.md contained non-ASCII emoji characters (✅, ❌, ⚠️) that cause JSON parser errors when users copy-paste configuration examples.

Changes:

  • Removed all emoji characters from JSON/JSON5 code blocks (9 instances):
    • ✅ (U+2705) check marks from "CORRECT" and "RECOMMENDED" comments
    • ❌ (U+274C) cross marks from "INCORRECT" and "Conflict!" comments
    • ⚠️ (U+26A0) warning signs from security notes
  • Changed code block marker from ```json to ```json5 at line 591 (block contains JSON5-style comments)
  • Added .windsurf/rules/documentation-standards.md to enforce ASCII-only JSON examples in documentation going forward

Example of fix:

// Before: // ✅ CORRECT: Use programming_language for standard Deephaven images
// After:  // CORRECT: Use programming_language for standard Deephaven images
{
  "session_creation": {
    "defaults": {
      "launch_method": "docker",
      "programming_language": "Python"  // Uses ghcr.io/deephaven/server:latest
    }
  }
}

Validation:

  • ✅ All 22 JSON/JSON5 code blocks verified to contain only ASCII characters
  • ✅ All 12 ```json blocks validated as parseable JSON
  • ✅ Documentation standards rule enforced via Windsurf configuration

Users can now safely copy-paste configuration examples without encountering parser errors due to non-ASCII characters. The documentation remains clear and readable with plain text labels. The new documentation standards rule ensures this issue won't recur in future documentation updates.

Original prompt

This section details on the original issue you should resolve

<issue_title>Fix: Example JSON contains non-UTF-8 characters</issue_title>
<issue_description>The example json in the markdown files contains non-UTF-8 characters. Users a copy and pasting the example code into configuration files. When reading these json files, the json parser raises an error. The non-UTF-8 characters should be removed from the example JSON in the markdown files.</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: chipkent <5250374+chipkent@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix example JSON to remove non-UTF-8 characters Fix: Mark JSON5 code block correctly in README Feb 12, 2026
Copilot AI requested a review from chipkent February 12, 2026 15:58
Copilot AI and others added 2 commits February 12, 2026 16:01
Co-authored-by: chipkent <5250374+chipkent@users.noreply.github.com>
Co-authored-by: chipkent <5250374+chipkent@users.noreply.github.com>
Copilot AI changed the title Fix: Mark JSON5 code block correctly in README Fix: Remove emoji characters from JSON/JSON5 code blocks in README Feb 12, 2026
Copilot AI requested a review from chipkent February 12, 2026 16:05
Co-authored-by: chipkent <5250374+chipkent@users.noreply.github.com>
Copilot AI changed the title Fix: Remove emoji characters from JSON/JSON5 code blocks in README Fix: Remove emoji characters from JSON/JSON5 code blocks and add documentation standards Feb 12, 2026
Copilot AI requested a review from chipkent February 12, 2026 16:23
@chipkent chipkent changed the title Fix: Remove emoji characters from JSON/JSON5 code blocks and add documentation standards fix: Remove emoji characters from JSON/JSON5 code blocks and add documentation standards Feb 12, 2026
@chipkent chipkent marked this pull request as ready for review February 12, 2026 16:43
@chipkent chipkent merged commit 347ad90 into main Feb 12, 2026
20 of 21 checks passed
@chipkent chipkent deleted the copilot/fix-non-utf8-characters-json branch February 12, 2026 16:46
@github-actions github-actions bot locked and limited conversation to collaborators Feb 12, 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.

Fix: Example JSON contains non-UTF-8 characters

2 participants