Skip to content

[Decision] Do docs-site breadcrumb labels follow the console-navigation convention or the page titles? Three spellings currently point at the same page #1545

Description

@os-sales

Raised by the repo:hotcrm PM seat, off an observation from #1125's R32 run. ⛔ Not dispatchable as filed — no convention exists to enforce, and inventing one is not a dev's call.

The observation

Docs-site breadcrumb link labels — the [Section › Page](/zh-Hant/docs/…) form used to cross-reference one docs page from another — are spelled inconsistently across zh-Hant pages while pointing at the identical target:

target spellings in use
/zh-Hant/docs/administration/automation [管理 › 自動化] ×5 · [Administration › Automation] ×4
the Extending Objects page [Customization › Extending Objects] ×5 · [自訂 › 擴充物件] ×4 · [定制 › 擴展物件] ×3

⭐ Note the third row: 定制 › 擴展物件 is Simplified vocabulary in Traditional script — 定制 and 擴展 are the mainland word choices, where Taiwanese usage is 自訂 and 擴充. So one page's breadcrumb is neither the English form nor the Traditional form.

Why this is a ruling and not a cleanup

#1113 and #1368 settled that console navigation is labelled in English on zh-Hant pages, for a measured reason: the platform ships no Traditional pack, so the console falls back to Simplified, and a Traditional page names console paths in English rather than mix Simplified glyphs into Traditional prose.

That reason does not transfer. A docs-site breadcrumb does not name a console screen — it names another page of this documentation, which does exist in Traditional and whose own title: frontmatter is written in Traditional. The argument from "no Traditional pack" is silent here, and applying the console convention by analogy would mean a zh-Hant page linking to a zh-Hant page under an English label.

So there are two defensible conventions and the repo is currently running all three:

A — breadcrumbs follow the linked page's own title. [管理 › 自動化]. Internally consistent: the reader clicks through and sees that title. ⚠️ Means two different conventions live in adjacent sentences on the same page — English for console paths, Traditional for docs paths — which is exactly the "spelled two ways" complaint #1125 was filed about.

B — breadcrumbs follow the console convention, i.e. English. [Administration › Automation]. One rule for every X › Y form on the page, nothing to remember. ⚠️ Labels a Traditional page in English for a reader who is about to land on Traditional prose, and the measured reason for the console rule does not support it.

C — something narrower, e.g. English for sections that mirror console apps, Traditional for the rest. ⛔ The seat does not recommend this; a rule keyed on a distinction readers cannot see is how the current three-way split happened.

⚠️ Whichever is ruled, 定制 › 擴展物件 is wrong under all three — Simplified vocabulary in a Traditional page is not an option any convention endorses. That much can be fixed without a ruling if the maintainer prefers to split it out.

What is deliberately not being done

#1125's dev left guides/import-and-export.zh-Hant.mdx:163 [管理 › 設定] untouched on purpose, despite it being on a page that claim held exclusively and despite containing 設定. ⭐ That was the right call and the seat is recording it: it is a docs breadcrumb, not a console path, so #1368's ruling does not reach it and fixing it would have quietly established convention B by fait accompli.

If ruled

Scope is a sweep of every [… › …](…) breadcrumb across content/docs/**/*.zh-Hant.mdx (and ⚠️ the question applies to .zh-Hans.mdx too — the seat has not measured whether the same three-way split exists there, and whoever takes it must, rather than assuming symmetry). ⚠️ A guard is worth considering so the answer does not drift back, but ⛔ do not build one in the same PR as the sweep — the ledger-and-prose coupling on #1544 shows why that pairing wants its own round.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationneeds-user-decisionNeeds the maintainer's call before work proceeds

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions