Document kinds viewer
Render each declared document-kinds directory: every kind’s structure, sections and sources, one page per subject layer.
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, 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, iris-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.
| port | type | required | description | constraint | |
|---|---|---|---|---|---|
| in | check | Flag | Fail if a page is stale, instead of writing. | boolean · A boolean switch — projects to a bare flag, with no value word | |
| in | site | RepoPath | A site being built: write the pages at their declared route under it instead of under the harness’s own site directory. A repository’s own site build passes it (the tools layer’s visualiser-writers.ts), since its harness docs are a pinned mount. | string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments. | |
| out | pages | RepoPath | The viewer pages, 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 document-kinds:viz.cat document-kinds:vizrunsbun run cat-harness-tools/scripts/gen-document-kinds-viz.ts(declared incat-harness-tools/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.
| install | none |
| runtime | bun |
| network | no |
What it is made of
| role | file | |
|---|---|---|
| definition | cat-harness/tools/document-kinds-viewer/document-kinds-viewer.json | |
| script | cat-harness-tools/scripts/gen-document-kinds-viz.ts |
It draws the viewer for the graph typology document-kinds.
Linked data
The Tool is published as its own JSON-LD document at its IRI, https://litlfred.github.io/folio-assistant/cat-harness/tools/document-kinds-viewer.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/cat-harness/cat-harness.context.jsonld",
"@id": "https://litlfred.github.io/folio-assistant/cat-harness/tools/document-kinds-viewer.jsonld",
"@type": "https://litlfred.github.io/cat-harness/v0/ns/Tool",
"partOf": "https://litlfred.github.io/folio-assistant/cat-harness/cat-harness.jsonld",
"name": "document-kinds-viewer",
"title": "Document kinds viewer",
"description": "Render each declared document-kinds directory: every kind's structure, sections and sources, one page per subject layer.",
"install": {
"none": true
},
"invoke": {
"shell": "bun run cat document-kinds:viz"
},
"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: write the pages at their declared route under it instead of under the harness's own site directory. A repository's own site build passes it (the tools layer's `visualiser-writers.ts`), since its harness docs are a pinned mount.",
"required": false,
"arg": {
"flag": "--site"
}
}
],
"outputs": [
{
"name": "pages",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
"description": "The viewer pages, under the published site directory."
}
]
},
"satisfies": [
"graph-rendering"
],
"requirements": {
"runtime": [
"bun"
],
"network": false
},
"renders": [
"document-kinds"
]
}