Reference
Four pages, for looking things up rather than reading through. The journey pages link into these; they do not restate them.
| Page | What it answers |
|---|---|
| CLI reference | Every command, argument and flag, with the exit code each produces. Drift-checked against src/graph/cli.ts in CI, so it cannot fall behind the code. |
| Configuration reference | Every graph: key of manni.config.yaml, with type and default, plus how the family’s collections: and providers: reach this tool. |
| Library API reference | The graph namespace of the package, and the dependency-free browser runtime published beside it. |
| Glossary | Triple, focus node, turn, harvest rule, and the rest. One page per term, in the family termbase. |
The three contracts
Section titled “The three contracts”Three files decide what manni graph accepts and produces, and each is versioned and immutable once published.
The page vocabulary, manni:graph:1.0.0. What a graph: block
may contain. There is no graph validate. A graph: block is frontmatter, so
manni meta validate checks it against this vocabulary. See
Checking a graph: block. The
vocabulary is bundled into the build, so the published package never reads a
file from the repository it was built in.
The shapes, shapes/graph/shapes-1.4.0.ttl. What the built graph must look
like, validated by manni graph check. They ship in the npm package because
check reads them at run time. They are closed, so a predicate they have not
learned fails.
The namespace, https://hawkeyexl.github.io/manni/graph/ns#. The terms the
emitter mints that no standard vocabulary covers. The IRI dereferences to a
document defining every one of them. That is why it is this IRI rather than a
host serving a 404. The custom set stays deliberately small: a Dublin Core,
SKOS, PROV, schema.org, FOAF or iiRDS term is preferred wherever one exists.
Elsewhere in the family
Section titled “Elsewhere in the family”| Page | Why you would go there |
|---|---|
| Configuration reference (meta) | collections: and providers:, the two top-level keys graph reads and does not own. |
| Schema resolution | How a schema reaches a file, which is what decides where x-manni-graph-output is read from. |
| Field location | x-manni-location, the mark that sits beside x-manni-graph-output in the same schema. |
| Output formats and exit codes | The notice | warning | error scale every tool shares, and how SHACL’s own severities map onto it. |
| TypeScript API (meta) | The whole package surface, of which graph is one namespace. |