glossary

Software terminology and concepts

Install

docsloth component add @docsloth/glossary@1.0.0

Live package: sha256:4c45f87cd38b58fb19b59de4a2be037be83e84a9916428231b304342ccc9b144 with 2 file digest(s); the catalog entry is generated from the built package, not a placeholder.

Props

The prop schema is normative in packages/contracts/component-props/glossary.schema.json.

Example props generated from this schema:

{
  "title": "example-title",
  "items": [
    {
      "term": "example-term",
      "definition": "example-definition",
      "aliases": [
        "example-aliases"
      ],
      "fact_ids": [
        "00000000-0000-4000-8000-000000000000"
      ]
    }
  ]
}

Required props: items.

Example

Example document IR (the block the renderer consumes):

{
  "type": "glossary",
  "props": {
    "title": "example-title",
    "items": [
      {
        "term": "example-term",
        "definition": "example-definition",
        "aliases": [
          "example-aliases"
        ],
        "fact_ids": [
          "00000000-0000-4000-8000-000000000000"
        ]
      }
    ]
  }
}

Renderer HTML (entities decoded and wrapped for display):

<section class="ds-block ds-glossary" data-component="glossary" aria-labelledby="b-title">
<h3 class="ds-block-title" id="b-title">example-title</h3>
<dl class="ds-terms">
<dt>
<dfn>example-term</dfn>
</dt>
<dd>example-definition</dd>
<dd>Also called: example-aliases.</dd>
</dl>
</section>

Preview (interface-only; the markup above is the same output):

The renderer resolves this component as a native block; the preview above is its real HTML output, and Markdown parity for native blocks is covered by the renderer test suite.

Specification

Generated from packages/contracts/component-specs/glossary.md.

Contract

Production props are normative in ../contracts/component-props/glossary.schema.json. The corresponding component-fixtures manifest is only a minimal protocol fixture; use the production props schema when building the published package. The packaged artifact ships exactly its generated component-package.json manifest plus props.schema.json (the production props schema, copied byte-for-byte) and spec.md (this spec, copied byte-for-byte); it contains no executable payload, fallback implementation, Storybook, test suite, SSR harness or README. Rendering behavior and the acceptance cases below belong to the renderer and the repository tests, not to the package. Installation pins the package version and the digest of every shipped byte.

Intended behavior

Search terms/aliases, stable anchors and reusable references.

Failure and fallback

Conflicting definitions flag review.

Current React behavior

The production glossary renders all terms, full definitions and aliases as an accessible definition list. Local search appears after hydration and matches visible text with Unicode normalization; fact identifiers remain metadata. Links use unique widget-scoped term anchors, stable during filtering and reordering of distinct terms. Exact API names are never replaced with aliases. Multiple definitions for the same exact term remain visible with a review notice. Server output retains all entries without requiring JavaScript. The static native renderer remains read-only; cross-page reference resolution and constrained agent-tool dispatch require host integration.

Required acceptance cases

No synonym replaces exact API names. Also test empty data, loading, denied access, browser without JS, mobile 360px, keyboard navigation, dark mode and an explicit constrained agent tool call. The server independently authorizes capability requests; a package manifest cannot grant authority.

Data and maintenance

Data bindings resolve from a specific publication/release vector and permitted fact/evidence graph. Configuration edits create versioned component patches. Update invalidation uses dependency IDs, never indiscriminate whole-page regeneration. Human-owned props survive automatic updates unless invalidated with an explicit conflict. Missing optional resources leave an honest inert/readable fallback, not a broken page or fake success.

Cost and tools

Pure/local interaction must never invoke a model by accident. Any model, remote query or executor call must reserve approved budget before dispatch. Public visitors do not inherit owner resources. The component may call only named tools in its signed manifest with valid typed inputs. A cancelled job stops polling and closes resources. No component gets platform administration, raw credentials or an unlimited execution loop.

Package manifest

Protocol fixture: packages/contracts/component-fixtures/glossary.json.

Sources