Documentation & Diagrams (robos.docs)

Living documentation pages, architecture decision records (ADRs), interactive walkthroughs, and visual flow diagrams with AI illustrations.

Table of contents

  1. Package Metadata
  2. Package Schemas & Constraint Shapes
  3. Package Architecture & Linked Data Model

Package Metadata

  • Package Store ID: documentation
  • Ontology Namespace: robos.docs
  • GitOps Package File: .robos/kgraphs/documentation/package.jsonld
  • Schemas Defined: 7

Package Schemas & Constraint Shapes

Schema Class Target Shape URI Required Properties (minCount ≥ 1) Specification
Flow Diagram (robos:FlowDiagram) urn:robos:shape:FlowDiagramShape dcterms:title, dcterms:description, robos:mermaidText, robos:imagePath, robos:tooltip View Schema →
Documentation Page (robos:DocumentationPage) urn:robos:shape:DocumentationPageShape dcterms:title, robos:slug, robos:docPath View Schema →
Architecture Decision Record (robos:ArchitectureDecisionRecord) urn:robos:shape:ArchitectureDecisionRecordShape dcterms:title, robos:status, robos:context, robos:decision View Schema →
Interactive Walkthrough (robos:InteractiveWalkthrough) urn:robos:shape:InteractiveWalkthroughShape dcterms:title, robos:slug, robos:targetApp View Schema →
Code Snippet (robos:CodeSnippet) urn:robos:shape:CodeSnippetShape dcterms:title, robos:language, robos:code View Schema →
Doc Section (robos:DocSection) urn:robos:shape:DocSectionShape dcterms:title, robos:sectionId, robos:docPage View Schema →
ADR Option (robos:ADROption) urn:robos:shape:ADROptionShape dcterms:title, robos:adr View Schema →

Package Architecture & Linked Data Model

Documentation & Diagrams (robos.docs) Ontology Map
Documentation & Diagrams (robos.docs) (robos.docs): High-level package ontology within the RobOS Knowledge Graph. (Click image to zoom full screen)

Table of contents