Skip to content

docs: document country name matching in region maps - #11421

Open
igorlukanin wants to merge 4 commits into
masterfrom
igor/cub-3549-document-country-name-matching
Open

docs: document country name matching in region maps#11421
igorlukanin wants to merge 4 commits into
masterfrom
igor/cub-3549-document-country-name-matching

Conversation

@igorlukanin

Copy link
Copy Markdown
Member

Summary

Region maps join a query dimension to the boundary data by name or ISO code, and the World Countries boundaries use long-form names — so United States in a user's data did not match the United States of America polygon. That join is now tolerant of alternate spellings, and this documents the behavior.

Added a Country name matching section under Region map covering what resolves (long forms, endonyms, abbreviations, both ISO code properties, in either direction), the two guarantees worth knowing — matching is exact rather than approximate, and bare 2-letter codes only count as country codes when Property is set to an ISO code property — and that this applies to World countries only, not US states or Custom.

Test plan

  • Prose-only change to an existing page; no new files, links, or frontmatter
  • CI must pass

@igorlukanin
igorlukanin requested a review from keydunov as a code owner July 29, 2026 22:47
@claude

claude Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Claude finished @igorlukanin's task in 1m 38s —— View job


Review complete — docs-only change, no blockers. 3 findings: 2 medium, 1 low (all inline).

Full review
  • Read PR diff (git diff origin/master...HEAD)
  • Read the full page for context and consistency
  • Check conventions against docs-mintlify/CLAUDE.md and root CLAUDE.md
  • Check for existing/stale review threads (none — nothing to resolve or dedupe against)
  • Post review

Scope

Prose-only addition of one H3 section to an existing page in docs-mintlify (the active docs site) — 8 added lines, no new files, no docs.json change needed, no frontmatter change, no code. The usual code-review axes (security, performance, error handling, test coverage) don't apply here; the applicable axis is documentation accuracy and consistency.

What's good

  • Correct site (docs-mintlify, not the deprecated /docs), correct heading level (H3 under the existing Region map H2), no stray H1.
  • Follows the "edit an existing page, don't create one" guidance in docs-mintlify/CLAUDE.md, and stays concise — three paragraphs, no padded Overview/Best-practices scaffolding.
  • Documents the negative cases, which is the part users actually need: exact-not-fuzzy matching, and the explicit "World countries only" scope limit for US states / Custom. Stating what doesn't resolve is what keeps this section from becoming a support ticket.
  • Bold UI labels (Property, World countries, Custom) match how the rest of the page refers to settings-panel controls.

Findings

# Severity File:line Issue
1 Medium map.mdx:72-74 Paragraphs 1 and 2 contradict each other on US: para 1 calls US unconditionally interchangeable with United States, para 2 says bare 2-letter codes only count when Property is an ISO code property
2 Medium map.mdx:78 The new H3 is inserted above the pre-existing choropleth-gradient paragraph, so that paragraph now renders inside the Country name matching subsection instead of the Region map intro
3 Low map.mdx:74 colouring — British spelling; every other instance in this file and in docs-mintlify prose is American (colored, colors, Default color)

Details and suggested edits are in the inline comments.

Minor notes (not worth inline threads)

  • Line 76: "must match the chosen Property exactly (ignoring case and surrounding whitespace)" is mildly self-undercutting — "exactly" then two exceptions. "must match the chosen Property, ignoring case and surrounding whitespace" reads cleaner, but this is taste.
  • The DE example is well chosen (state code that collides with a country code), though it leans on the reader knowing DE is Delaware. Fine as is.

What I could not verify

The behavior being documented lives in the frontend/chart implementation, which isn't in this repo — rg for ISO3166 / world countries matches only this .mdx. I reviewed the section for internal consistency, conventions, and clarity, but I can't confirm the claims against the matching code: specifically whether an Alpha-3 ISO code property is exposed by the World countries source (para 1 promises 2- and 3-letter, while the Property example list at line 62 shows only ISO3166-1-Alpha-2), and whether reverse matching (name in data, code as Property) behaves as described. Someone with access to the implementation should sanity-check those two.

I did not run the Mintlify dev server or a linter — this is a prose-only .mdx edit with no components, links, or frontmatter touched, so there is nothing for either to catch beyond what CI already runs.

• [Branch](https://github.com/cube-js/cube/tree/igor/cub-3549-document-country-name-matching)

@mintlify

mintlify Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cubed3 🟢 Ready View Preview Jul 29, 2026, 10:48 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Comment thread docs-mintlify/docs/explore-analyze/charts/chart-types/map.mdx Outdated
Comment thread docs-mintlify/docs/explore-analyze/charts/chart-types/map.mdx Outdated
Comment thread docs-mintlify/docs/explore-analyze/charts/chart-types/map.mdx Outdated
@mintlify

mintlify Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cubed3 🟡 Building Jul 29, 2026, 10:47 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@claude

claude Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Claude finished @igorlukanin's task in 46s —— View job


Re-review after c16cc12 — all 3 prior findings fixed, no new issues. Approve-equivalent (docs-only).

Full review
  • Read the updated page (map.mdx) after the fix commit
  • Verify each of the 3 prior findings
  • Check for stale review threads to resolve (all 3 already auto-resolved as outdated)
  • Look for new issues introduced by the fixes
  • Post updated review

Verification of prior findings

# Prior issue Status
1 Para 1 vs para 2 contradiction on US ✅ Fixed — US dropped from the interchangeable list at map.mdx:74; para 2 (map.mdx:76) now introduces it as "Bare 2-letter codes such as US…". The two paragraphs no longer disagree.
2 H3 inserted above the choropleth-gradient paragraph ✅ Fixed — the palette sentence is back in the Region map H2 intro at map.mdx:70, with ### Country name matching starting at map.mdx:72.
3 colouring British spelling ✅ Fixed — now coloring at map.mdx:76.

Bonus: the Alpha-3 gap I flagged as an aside is closed too — map.mdx:62 now lists ISO3166-1-Alpha-3 alongside ISO3166-1-Alpha-2, so the Property list and the "2- and 3-letter ISO code properties" claim at map.mdx:74 line up. The author confirmed the World countries source exposes both.

Thread housekeeping

All three of my threads were already resolved (GitHub marked them outdated once the lines moved) — nothing left to resolve, and no duplicate inline comments to skip.

New issues

None. The rewrite is a clean subtraction plus a move — no new claims were introduced, and the sentence flow reads correctly with US deferred to the second paragraph. Section structure is now: H2 intro (requirements list → allowed-properties note → auto-pick → palette) → ### Country name matching### Custom GeoJSON, which is consistent with how Point map is broken up earlier on the page.

Standing caveat (unchanged)

The matching behavior itself lives outside this repo, so I still can't verify the claims against the implementation — reverse matching (name in data, code as Property) in particular. The author's confirmation on Alpha-3 covers the one piece I could point at concretely. This is a prose-only .mdx change with no components, links, or frontmatter touched, so the code-review axes in the review config (security, performance, error handling, test coverage) don't apply; the Mintlify preview build is the relevant check and it's green.

Branch

@igorlukanin
igorlukanin force-pushed the igor/cub-3549-document-country-name-matching branch from c16cc12 to 68c22f2 Compare August 5, 2026 15:35
@claude

claude Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Claude finished @igorlukanin's task in 48s —— View job


Re-review after force-push (417e151+68c22f2) — content identical to the already-approved state; no new findings. Docs-only, no blockers.

Full review
  • Read PR diff (git diff origin/master...HEAD)
  • Read the full page for context and consistency
  • Compare against the state reviewed on Jul 30 (c16cc12)
  • Check existing review threads (resolve stale / dedupe)
  • Look for new issues
  • Post review

What changed in this sync

Nothing in the content. The branch history was rewritten — the two prior commits were replaced by 417e151 ("document country name matching in region maps") and 68c22f2 ("fix Region map section placement, US-code wording and spelling") — but the resulting tree is byte-identical to the c16cc12 state I reviewed on Jul 30. git diff origin/master...HEAD is still the same 9-added/1-deleted change to a single file, and the blob SHA (165ce16) matches. The fix commit was just folded into a cleaner two-commit history.

Current state (map.mdx:62, :70–78)

All three prior findings remain fixed:

# Prior issue Status
1 Para 1 vs para 2 contradiction on US US is absent from the interchangeable list at map.mdx:74 and introduced at map.mdx:76 as "Bare 2-letter codes such as US…"
2 H3 inserted above the choropleth-gradient paragraph ✅ Palette sentence sits in the Region map H2 intro at map.mdx:70; ### Country name matching starts at map.mdx:72
3 colouring British spelling coloring at map.mdx:76
Alpha-3 gap (aside) ISO3166-1-Alpha-3 listed at map.mdx:62, matching the "2- and 3-letter ISO code properties" claim

Section structure reads: H2 intro (requirements → allowed-properties → auto-pick → palette) → ### Country name matching### Custom GeoJSON### Unmatched regions, consistent with how Point map is broken up earlier on the page. Conventions check out — correct site (docs-mintlify, not the deprecated /docs), H2/H3 only with no stray H1, bold UI labels matching the rest of the page, no docs.json or frontmatter change needed for a prose-only edit.

Thread housekeeping

All three of my earlier threads are already isResolved: true and outdated — nothing to resolve, and no duplicate inline comments to post or skip.

Minor note (not worth an inline thread)

map.mdx:74 — "The same applies to the 2- and 3-letter ISO code properties" is slightly loose, since codes don't have alternate spellings the way names do; the clause that follows ("it works in either direction") is what actually carries the meaning. Reads fine as is; only worth touching if you're editing the sentence anyway.

Standing caveat (unchanged)

The matching behavior lives outside this repo — rg for ISO3166 / world countries hits only this .mdx — so I can't verify the claims against the implementation, reverse matching (name in data, code as Property) in particular. The author confirmed the World countries source exposes Alpha-3, which covers the one piece I could point at concretely.

The code-review axes in the review config (security, performance, error handling, test coverage) don't apply to a prose-only .mdx change with no components, links, or frontmatter touched. I did not run the Mintlify dev server or a linter — there's nothing for either to catch here beyond what CI runs; the Mintlify preview build is the relevant check.

• [Branch](https://github.com/cube-js/cube/tree/igor/cub-3549-document-country-name-matching)

@claude

claude Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Claude finished @igorlukanin's task in 42s —— View job


Re-review after 227f2cc (Source label casing) — casing is now internally consistent; no blockers. 0 findings, 1 style note.

Full review
  • Read PR diff (git diff origin/master...HEAD)
  • Read the full page for context and consistency
  • Diff the new commit against the previously reviewed state
  • Check existing review threads (resolve stale / dedupe)
  • Look for new issues
  • Post review

What changed in this sync

One new commit, 227f2cc — a pure casing change to the Source option labels:

Location Before After
map.mdx:61 `World countries`, `US states` `World Countries`, `US States`
map.mdx:74, :78 World countries, US states World Countries, US States

ISO3166-1-Alpha-3 at map.mdx:62 was already in the tree from 68c22f2; the diff hunk just re-renders that line alongside the Source edit. No prose, structure, or claims changed.

Assessment

Consistent — grep -niE "world countries|us states" over docs-mintlify returns only this file, and every occurrence of the two labels is now title-cased in the same way. Custom was already title-cased, so all three Source options match each other.

map.mdx:9 still reads "countries, US states, or any custom GeoJSON" in lowercase, but that's the intro sentence describing what a region map paints, not a reference to the settings-panel option — leaving it lowercase is correct.

The three prior findings remain fixed (US-code contradiction, H3 placement, colouringcoloring), and section structure is unchanged: H2 intro → ### Country name matching### Custom GeoJSON### Unmatched regions.

Style note (not worth an inline thread)

map.mdx:61 renders the option labels in backticks (`World Countries`) while :74 and :78 render them in bold (World Countries), and :82 uses bold for Custom too. Bold is what the rest of the page uses for UI controls (Property, Size, Fill unmatched, Default color). Since you're already touching that line for casing, switching it to bold would make the whole page consistent — but this predates the PR and reads fine either way.

Thread housekeeping

All three of my earlier threads are isResolved: true and outdated. Nothing to resolve, no duplicates to skip.

Standing caveat (unchanged)

I can't verify the casing against the actual UI, or the matching behavior against its implementation — both live outside this repo (rg for ISO3166 / World Countries hits only this .mdx). I'm taking the commit message's claim that these match the UI at face value; the check I can make is internal consistency, and that holds. Reverse matching (name in data, code as Property) likewise remains unverifiable from here.

Prose-only .mdx change with no components, links, or frontmatter touched, so the code-review axes in the review config (security, performance, error handling, test coverage) don't apply. The Mintlify preview build is the relevant check; I did not run the dev server or a linter, as there's nothing for either to catch beyond what CI runs.

Branch

@claude

claude Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Claude finished @igorlukanin's task in 31s —— View job


Re-review after a00ba11 (Source labels → bold) — resolves my prior style note; 0 findings, no blockers.

Full review
  • Read PR diff (git diff origin/master...HEAD)
  • Read the full page for context and consistency
  • Diff the new commit against the previously reviewed state
  • Check existing review threads (resolve stale / dedupe)
  • Look for new issues
  • Post review

What changed in this sync

One new commit, a00ba11, applying the style note from my last pass — the Source option labels at map.mdx:61 moved from backticks to bold:

Location Before After
map.mdx:61 `World Countries`, `US States`, `Custom` World Countries, US States, Custom

No prose, structure, or claims changed.

Assessment

This closes the last thing I had. The page now uses bold uniformly for settings-panel controls — Source, Property, Dimension, Measure, Size, Color, Default color, Fill unmatched — and the three Source option values render the same way at :61, :74, :78, and :82. Backticks are left for actual data values and property keys (name, ISO3166-1-Alpha-2, United States, DE), which is the right split: bold = thing you click, code = thing you type or that appears in your data.

map.mdx:9 still reads "countries, US states, or any custom GeoJSON" in lowercase plain text, but that's the intro describing what a region map paints, not a reference to the option — correctly left alone.

All three original findings remain fixed:

# Prior issue Status
1 Para 1 vs para 2 contradiction on US US absent from the interchangeable list at :74, introduced at :76 as "Bare 2-letter codes such as US…"
2 H3 inserted above the choropleth-gradient paragraph ✅ Palette sentence sits in the H2 intro at :70; ### Country name matching starts at :72
3 colouring British spelling coloring at :76
Alpha-3 gap (aside) ISO3166-1-Alpha-3 listed at :62
Backticks vs bold for Source options (style note) ✅ Fixed by this commit

Section structure unchanged: H2 intro (requirements → allowed properties → auto-pick → palette) → ### Country name matching### Custom GeoJSON### Unmatched regions, mirroring how Point map is broken up earlier on the page. Conventions check out — correct site (docs-mintlify, not the deprecated /docs), H2/H3 only, no docs.json or frontmatter change needed for a prose-only edit.

New issues

None.

Thread housekeeping

All three of my earlier threads are isResolved: true and outdated — nothing to resolve, no duplicates to skip.

Standing caveat (unchanged)

The matching behavior lives outside this repo — rg for ISO3166 / World Countries hits only this .mdx — so I can't verify the claims against the implementation, reverse matching (name in data, code as Property) in particular. I likewise can't check the label casing against the actual UI and am taking the commit message at face value; what I can check is internal consistency, and that holds.

Prose-only .mdx change with no components, links, or frontmatter touched, so the code-review axes in the review config (security, performance, error handling, test coverage) don't apply. I did not run the Mintlify dev server or a linter — there's nothing for either to catch beyond what CI runs; the Mintlify preview build is the relevant check.

• [Branch](https://github.com/cube-js/cube/tree/igor/cub-3549-document-country-name-matching)

@claude

claude Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Claude finished @igorlukanin's task in 40s —— View job


Re-review after force-push (509b25918b755b) — tree is byte-identical to the already-reviewed state; 0 findings, no blockers.

Full review
  • Read PR diff (git diff origin/master...HEAD)
  • Read the full page for context and consistency
  • Compare against the previously reviewed state (a00ba11)
  • Check existing review threads (resolve stale / dedupe)
  • Look for new issues
  • Post review

What changed in this sync

Nothing in the content. The branch history was rewritten again — the four commits are now 509b259ce532f555d6b0318b755b, the same four steps under new SHAs (document → fix placement/wording/spelling → Source label casing → Source labels to bold). The resulting blob for map.mdx is acbc7e8, identical to the state I reviewed on Aug 5 after a00ba11, and git diff origin/master...HEAD is still the same +10/−2 single-file change.

Current state

Location Content
map.mdx:61 Source options in bold: World Countries, US States, Custom
map.mdx:62 Property list includes both ISO3166-1-Alpha-2 and ISO3166-1-Alpha-3
map.mdx:70 Palette/gradient sentence sits in the Region map H2 intro
map.mdx:72–78 ### Country name matching — three paragraphs

All prior findings remain fixed:

# Prior issue Status
1 Para 1 vs para 2 contradiction on US US absent from the interchangeable list at :74, introduced at :76 as "Bare 2-letter codes such as US…"
2 H3 inserted above the choropleth-gradient paragraph ✅ Palette sentence in the H2 intro at :70; H3 starts at :72
3 colouring British spelling coloring at :76
Alpha-3 gap (aside) ✅ Listed at :62
Backticks vs bold for Source options (style note) ✅ Bold throughout

Consistency check still holds: grep -niE "world countries\|us states" over docs-mintlify returns only this file, and every settings-panel reference to the two labels is title-cased and bold. map.mdx:9 stays lowercase plain text, which is correct — it describes what a region map paints, not the option. Bold is used for controls, backticks for data values and property keys.

Conventions: correct site (docs-mintlify, not the deprecated /docs), H2/H3 only with no stray H1, no docs.json or frontmatter change needed for a prose-only edit. Section structure — H2 intro → ### Country name matching### Custom GeoJSON### Unmatched regions — mirrors how Point map is broken up earlier on the page.

New issues

None.

Thread housekeeping

All three of my earlier threads are isResolved: true and outdated — nothing to resolve, no duplicates to skip.

Standing caveat (unchanged)

The matching behavior lives outside this repo — rg for ISO3166 / World Countries hits only this .mdx — so I can't verify the claims against the implementation, reverse matching (name in data, code as Property) in particular. I likewise can't check the label casing against the actual UI and am taking the commit message at face value; internal consistency is what I can check, and it holds.

Prose-only .mdx change with no components, links, or frontmatter touched, so the code-review axes in the review config (security, performance, error handling, test coverage) don't apply. I did not run the Mintlify dev server or a linter — there's nothing for either to catch beyond what CI runs; the Mintlify preview build is the relevant check.

Branch

@igorlukanin
igorlukanin force-pushed the igor/cub-3549-document-country-name-matching branch from 18b755b to dc1ebbe Compare August 18, 2026 22:34
@claude

claude Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Claude finished @igorlukanin's task in 37s —— View job


Re-review after force-push (afe13fbdc1ebbe) — content byte-identical to the already-reviewed state; 0 findings, no blockers.

Full review
  • Read PR diff (git diff origin/master...HEAD)
  • Read the full page for context and consistency
  • Compare against the previously reviewed state (18b755b)
  • Check existing review threads (resolve stale / dedupe)
  • Look for new issues
  • Post review

What changed in this sync

Nothing in the content — another history rewrite. The four commits are now afe13fbfcb061dffbb99cdc1ebbe, the same four steps under new SHAs (document → fix placement/wording/spelling → Source label casing → Source labels to bold). The map.mdx blob is still acbc7e8, identical to the state reviewed on Aug 13, and git diff origin/master...HEAD is the same +10/−2 single-file change.

Current state

Location Content
map.mdx:61 Source options in bold: World Countries, US States, Custom
map.mdx:62 Property list includes both ISO3166-1-Alpha-2 and ISO3166-1-Alpha-3
map.mdx:70 Palette/gradient sentence sits in the Region map H2 intro
map.mdx:72–78 ### Country name matching — three paragraphs

All prior findings remain fixed:

# Prior issue Status
1 Para 1 vs para 2 contradiction on US US absent from the interchangeable list at :74, introduced at :76 as "Bare 2-letter codes such as US…"
2 H3 inserted above the choropleth-gradient paragraph ✅ Palette sentence in the H2 intro at :70; H3 starts at :72
3 colouring British spelling coloring at :76
Alpha-3 gap (aside) ✅ Listed at :62
Backticks vs bold for Source options (style note) ✅ Bold throughout

Conventions still check out — correct site (docs-mintlify, not the deprecated /docs), H2/H3 only with no stray H1, bold for settings-panel controls and backticks for data values / property keys, no docs.json or frontmatter change needed for a prose-only edit. Section structure — H2 intro → ### Country name matching### Custom GeoJSON### Unmatched regions — mirrors how Point map is broken up earlier on the page. map.mdx:9 stays lowercase plain text, correctly, since it describes what a region map paints rather than naming the option.

New issues

None.

Thread housekeeping

All three of my earlier threads are isResolved: true and outdated — nothing to resolve, no duplicates to skip.

Standing caveat (unchanged)

The matching behavior lives outside this repo — rg for ISO3166 / World Countries hits only this .mdx — so I can't verify the claims against the implementation, reverse matching (name in data, code as Property) in particular. I likewise can't check the label casing against the actual UI and am taking the commit message at face value; internal consistency is what I can check, and it holds.

Prose-only .mdx change with no components, links, or frontmatter touched, so the code-review axes in the review config (security, performance, error handling, test coverage) don't apply. I did not run the Mintlify dev server or a linter — there's nothing for either to catch beyond what CI runs; the Mintlify preview build is the relevant check.

• [Branch](https://github.com/cube-js/cube/tree/igor/cub-3549-document-country-name-matching)

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