Skip to content

51Did docs: replace 'Special license key required' placeholder with the agreed marketing-license wording and mechanism #148

Description

@jwrosewell

Naming decisions (added 2026-06-06)

The canonical spelling of the identifier is 51Did — capital D, lowercase i, lowercase d. First reference on any reader entry point expands to 51Degrees Identifier (51Did). Subsequent references use the short form.

Do not write in public docs: 51DiD, 51DID, 51did (in prose), Fodid, FODID, FodID, FoDiD, FODiD, 51-Did, 51 Degrees Id, 51Deg Id. Internal cloud-side identifiers (FoDiD, FODiD, CloudV5FODiD, etc.) lag the public name and must not appear anywhere in src/.

Code / code-adjacent forms are allowed only where the language or wire format forces them:

  • FodId — code identifier names that cannot start with a digit (Rust struct / enum / trait / function names).
  • fodid — module names, file paths (the existing src/identifiers/fodid.md keeps this filename), TOML / settings provider strings (provider = "51did"), JSON response keys (the cloud returns a fodid block; consumers parse case-insensitively).

This issue itself has been edited from its original 51DiD spelling to the canonical 51Did form.

Spinning out of PR #135 review feedback. James called out on the Identifiers / 51Did page that CloudV5FODiD is the internal name for the SKU that unlocks id.usage=standard and id.usage=personalized 51Dids, and must not appear in public documentation.

For the PR I've replaced every CloudV5FODiD reference with the placeholder wording "Special license key required", but that's a stop-gap. Once the public wording / mechanism is agreed, the docs need to be updated to:

  1. Name the SKU / capability publicly. Whatever marketing decides to call this in public materials (e.g. "Marketing 51Did license", "51Did Marketing tier", etc.) should land in the docs in the canonical 51Did form.
  2. Describe how a customer obtains it. Today the doc just says "Contact 51Degrees to apply" — needs a concrete pointer (sales contact form URL, pricing page anchor, support email, etc.).
  3. Describe the KYC / Model Terms gate, in customer-facing language. The current paragraph captures the gist but is light on detail.

The two places to update once the wording is final:

  • src/identifiers/fodid.md — file path keeps fodid per the naming convention above; the page content already uses 51Did. Update the Usage policies and licensing table rows for standard / personalized, plus the paragraph immediately under it.
  • Anywhere else Special license key required shows up in future content (none today, but worth a grep before publishing the change).

A site-wide search confirms CloudV5FODiD no longer appears anywhere in src/ once PR #135 lands:

$ rg CloudV5FODiD src/
$ # (no matches)

While the SKU naming is being finalised, any new content that mentions the identifier should follow the Naming decisions callout above. A site-wide rg '51DiD|51DID|FODiD|FODID|FodID' over src/ should return no matches before publishing.

Assigning to @HuwM63 — you'll know best who owns the marketing-side naming and the application flow.

Activity

  1. changed the title [-]51DiD docs: replace 'Special license key required' placeholder with the agreed marketing-license wording and mechanism[/-] [+]51Did docs: replace 'Special license key required' placeholder with the agreed marketing-license wording and mechanism[/+] on Jun 6, 2026
  2. jwrosewell commented on Jun 6, 2026

    @jwrosewell
    ContributorAuthor

    Edited the issue body to lock in the 51Did spelling (capital D, lowercase i, lowercase d) and to enumerate which other forms are off-limits in public docs. The relevant differences from the original body:

    • Every prose 51DiD / 51DiDs is now 51Did / 51Dids.
    • The Identifiers / 51DiD page reference is now Identifiers / 51Did to match the doxygen @page Identifiers_51Did declaration in src/identifiers/fodid.md.
    • CloudV5FODiD stays spelled that way only inside the "internal SKU name" call-out, where it's quoted as the specific thing being banned from public docs.
    • New site-wide search recommendation: rg '51DiD|51DID|FODiD|FODID|FodID' src/ should return no matches before any docs PR ships, so future drift gets caught before merge.

    The naming rules themselves are the source of truth from the 51did-spelling-and-usage standing reference, not a new ad-hoc decision:

    • 51Did for prose, settings strings, log scopes, customer-facing UI labels.
    • 51Degrees Identifier (51Did) on first reference at any reader entry point (page top, module doc, PR / issue / changelog body, doc comment on any type whose name carries the abbreviation).
    • FodId only where a leading digit is illegal (Rust struct / enum / trait / function names).
    • fodid for module names, file paths, JSON response keys, TOML provider strings.
    • Internal FoDiD / FODiD / CloudV5FODiD etc. stay inside cloud-side source; they must not leak into src/.

    The substantive ask in this issue (replace the Special license key required placeholder with the agreed public SKU wording + customer application mechanism) still needs the marketing / sales decision before any further doc PR can land.

  3. jwrosewell commented on Aug 5, 2026

    @jwrosewell
    ContributorAuthor

    On hold. The wording this issue needs depends on the Model Terms for Marketing being settled, so the placeholder stays until that work concludes. Once the terms are settled the agreed wording and mechanism will be applied here.

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

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions