Skip to content

docs(plugins): internal codenames "Group F" and "T1" are in published JSDoc, so they render on JSR and now on the docs site #1554

Description

@rickylabs

Summary

packages/plugin-triggers-core describes its public types with the internal workstream codenames
"Group F" and "T1" in JSDoc. That JSDoc renders on JSR, and it has now propagated to the
documentation site, because a reference page written faithfully against deno doc reproduces
whatever the JSDoc says.

A consumer reading @netscript/plugin-triggers-core is told a type is "known by the Group F public
surface". Nothing published explains what Group F is, because it is an internal planning name.

Evidence

Verified at cd24e1679:

packages/plugin-triggers-core/src/domain/constants.ts:4
  /** Trigger kinds implemented by the Group F T1 runtime. */
packages/plugin-triggers-core/src/domain/constants.ts:18
  /** Canonical trigger kinds known by Group F. */
packages/plugin-triggers-core/src/domain/constants.ts:41
  /** Default durability tier for Group F trigger definitions. */
packages/plugin-triggers-core/src/domain/constants.ts:98
  /** Trigger kind implemented by the Group F T1 runtime. */
packages/plugin-triggers-core/src/domain/trigger-definition.ts:126
  /** Trigger definitions implemented by the Group F runtime. */

Propagated into the new reference page (docs/site/reference/plugin-triggers-core/index.md, PR
#1541), which mirrors the verified deno doc surface:

  • :89 — "Trigger definitions known by the Group F public surface."
  • :93 — "Canonical trigger kinds known by Group F."
  • :107 — "Payload union for known Group F trigger kinds."
  • :146 — "T1 trigger processor with idempotency, retry, concurrency, DLQ, and circuit breaker
    handling."

Why it matters

This is the third instance of the same class found in milestone 0.0.6, all in published JSDoc:

deno doc --lint checks that JSDoc exists and flags private type references; nothing checks what
it says. The documentation lane's audit gate does scan changed lines for internal wording, but it
scans docs/site, not packages/** source comments — which is why a docs pass caught this only
after the words had already been copied onto a public page.

The docs-side symptom is fixable by rewording the page, but that would make the page disagree with
deno doc, which is the authority the reference pages are written against. The fix belongs in the
source.

Scope

  • Replace "Group F" and "T1" in packages/plugin-triggers-core/** JSDoc with language a consumer can
    act on — what the type is, not which internal workstream produced it.
  • Sweep the rest of the publish set for the same class: internal workstream names, wave/epic
    codenames, and issue numbers in published JSDoc.
  • Consider extending the internal-wording scan to packages/**/plugins/** JSDoc, not only
    docs/site changed lines. Without that, the next codename reaches JSR the same way.

Boundaries

Acceptance criteria

  • No occurrence of "Group F" or "T1" in any published JSDoc under packages/**/plugins/**.
  • A repo-wide sweep records how many internal-codename occurrences were found and fixed, across
    the whole publish set rather than one package.
  • docs/site/reference/plugin-triggers-core/index.md matches the corrected deno doc output.
  • Negative test: reintroducing an internal codename into published JSDoc fails a check.

Provenance

Found by the docs_polish lane of the 0.0.6 documentation lane while reviewing PR #1541, and
returned as a doubt rather than edited — correctly, since the page mirrors the source. Confirmed
against packages/plugin-triggers-core/src/** by the orchestrator.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions