Skip to content

docs: fix README diagram rendering and remove redundant note - #149

Merged
JJasonSun merged 2 commits into
mainfrom
docs/remove-region-language-note
Sep 22, 2026
Merged

JJasonSun merged 2 commits into
mainfrom
docs/remove-region-language-note

Conversation

@JJasonSun

@JJasonSun JJasonSun commented Sep 22, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Fix the README tool-flow diagram by replacing a semicolon in its note with a comma. Mermaid treats the semicolon as a statement separator, which causes GitHub to reject the diagram. Also remove the redundant sentence above the supported-regions table.

README.md
  Tool flow: valid Mermaid note
  Country-code introduction
  Supported-regions table

Evidence

  • Before: GitHub displayed Unable to render rich display and a parse error on line 12 of the tool-flow diagram.
  • After: the GitHub branch preview renders the full sequence diagram, including the polling loop. The extra language-table sentence is absent.
  • The docs site's existing Regions parser accepts the README; all 22 table rows are unchanged. git diff --check passes.

Merge Danger

Door: two-way. The documentation edit can be reverted.

Blast Radius: documentation. Only the root README changes.

Release decision: No release needed; no packages, version bump, or changeset.

@JJasonSun JJasonSun changed the title docs: remove redundant language-table note docs: fix README diagram rendering and remove redundant note Sep 22, 2026
@JJasonSun
JJasonSun merged commit c8708d2 into main Sep 22, 2026
2 checks passed
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