PathMX BYOO (Bring Your Own Ontology) Guide

A core pillar of PathMX is "type hinted" file names. This allows you and your agents to reason about the role of each file in the repository.

A type hint is a file name prefixed with a type identifier. For example:

task.guide.md is a task guide
project-1.spec.md is a project specification
project-1.project.md the project itself (created from the spec)
week-1.lab.md a lab assignment

Ontologies should match the domain you are building for.

For example, if you are creating an event site, you may type hint files like this:

speaker-1.keynote.md
session-1.workshop.md
session-1.breakout.md

If not type hint is specified, the file will be typed as a document by default.

Paths

PathMX comes with one specicific ontology built in: the "path" ontology.

If you name a file with the suffix .path.md it will be parsed as a PathMX path.

A path is a way to sequence your content into a progressable learning path with support for locations, schedudling, presentors and more.

Tags

The Tags Plugin looks for *.tags.md files and parses them into re-usable HTML-like tag components. This allows you to build unique and bespoke user interfaces for your content.