who-iris catalogue and docs pages

Render who-iris’s docs pages, the catalogue visualiser at its declared route (what the catalogue knows, and what it records that it does not know), the library’s withheld list, and the IRIS replica’s home page.

Skills it satisfies

A skill states the capability; this Tool is one way to exercise it. Each skill’s declared input and output contract follows, where it has one.

graph-rendering

Draw any graph in a harness (schemas, processes, a folio’s block graph and any formal relation its content type adds, a detangle partition) so the picture is derived, checkable and readable. Ten rules, which engine to lay a graph out with and why, and how each graph typology here applies them.

Source: cat-harness/skills/kg/graph-management/graph-rendering.md.

Also satisfied by: auto-docs-viewer, content-graph-uml, document-kinds-viewer, external-schemas-viewer, folio-viewer, kg-viewer, library-viewer, lsi-viewer, methodologies-viewer, node-kind-pages, openapi-pages, processes-viewer, schemas-viewer, site-viewer, staging-graph-viewer, state-viewer, theme-viewer, tools-viewer, translation-status-viewer, uploads-viewer, voices-viewer, web-app-build, archimate-from-glossary, bibliography-page, glossary-page, glossary-table, references-render, l1-extraction-pages.

The skill declares no I/O contract (schemas/skills/graph-rendering/{input,output}.schema.json).

Inputs and outputs

Each port names a shared type by IRI, so two Tools for one skill can be checked for interchangeability.

porttyperequireddescriptionconstraint
incheckFlagFail if a page is stale, instead of writing.boolean · A boolean switch — projects to a bare flag, with no value word
insiteRepoPathA site being built (the tree compose-docs --shell wrote): write only the catalogue page into it, at its route in who-iris’s own site, plus a forwarding page at the declared route. A site build passes it (visualiser-writers.ts).string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments.
outpagesRepoPathThe replica’s home page at site/index.html (and its translations), the docs under docs/, and the catalogue page under the published site directory.string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments.

Processes and tasks

No process step names a skill this Tool satisfies.

How it is deployed and reached

  • Command line. From the repository root: bun run cat iris:pages. cat iris:pages runs bun run who-iris/scripts/gen-iris-pages.ts (declared in who-iris/package.json).
  • GitHub Actions. No workflow in this checkout runs its command.

As an API: its operation in the OpenAPI document and the MCP tool list of its layer.

installnone
runtimebun
networkno

What it is made of

It draws the viewer for the graph typology catalogue.

Linked data

The Tool is published as its own JSON-LD document at its IRI, https://litlfred.github.io/folio-assistant/who-iris/tools/iris-pages.jsonld, partOf its layer’s document. The node below is the definition this page was drawn from, and is embedded in the page as application/ld+json.

{
  "@context": "https://litlfred.github.io/folio-assistant/who-iris/who-iris.context.jsonld",
  "@id": "https://litlfred.github.io/folio-assistant/who-iris/tools/iris-pages.jsonld",
  "@type": "https://litlfred.github.io/cat-harness/v0/ns/Tool",
  "partOf": "https://litlfred.github.io/folio-assistant/who-iris/who-iris.jsonld",
  "name": "iris-pages",
  "title": "who-iris catalogue and docs pages",
  "description": "Render who-iris's docs pages, the catalogue visualiser at its declared route (what the catalogue knows, and what it records that it does not know), the library's withheld list, and the IRIS replica's home page.",
  "install": {
    "none": true
  },
  "invoke": {
    "shell": "bun run cat iris:pages"
  },
  "io": {
    "inputs": [
      {
        "name": "check",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Flag",
        "description": "Fail if a page is stale, instead of writing.",
        "required": false,
        "arg": {
          "flag": "--check"
        }
      },
      {
        "name": "site",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "description": "A site being built (the tree `compose-docs --shell` wrote): write only the catalogue page into it, at its route in who-iris's own site, plus a forwarding page at the declared route. A site build passes it (`visualiser-writers.ts`).",
        "required": false,
        "arg": {
          "flag": "--catalogue-into"
        }
      }
    ],
    "outputs": [
      {
        "name": "pages",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "description": "The replica's home page at `site/index.html` (and its translations), the docs under `docs/`, and the catalogue page under the published site directory."
      }
    ]
  },
  "satisfies": [
    "graph-rendering"
  ],
  "requirements": {
    "runtime": [
      "bun"
    ],
    "network": false
  },
  "renders": [
    "catalogue"
  ]
}

folio-assistant — code under the Apache License 2.0, documentation under CC BY 3.0. Generated schema and API references are rebuilt from source on every push to main.

deployed dev