Documentation & Diagrams (robos.docs)
Documentation pages, architecture decision records, flow diagrams, walkthroughs and code snippets.
| Package id | documentation |
| Namespace | robos.docs |
| Package file | .robos/kgraphs/documentation/package.jsonld |
| Classes documented | 8 |
Classes
Required properties are the ones with a minimum count of 1 or more. A node that lacks one fails validation.
| Class | Shape | Required properties |
|---|---|---|
Flow Diagram (robos:FlowDiagram) | urn:robos:shape:FlowDiagramShape | dcterms:title, dcterms:description, robos:mermaidText, robos:imagePath, robos:tooltip |
Documentation (robos:Documentation) | urn:robos:shape:DocumentationShape | dcterms:title, robos:targetEntity, robos:docPath, robos:gitopsFile |
Documentation Page (robos:DocumentationPage) | urn:robos:shape:DocumentationPageShape | dcterms:title, robos:slug, robos:docPath |
Architecture Decision Record (robos:ArchitectureDecisionRecord) | urn:robos:shape:ArchitectureDecisionRecordShape | dcterms:title, robos:status, robos:context, robos:decision |
Interactive Walkthrough (robos:InteractiveWalkthrough) | urn:robos:shape:InteractiveWalkthroughShape | dcterms:title, robos:slug, robos:targetApp |
Code Snippet (robos:CodeSnippet) | urn:robos:shape:CodeSnippetShape | dcterms:title, robos:language, robos:code |
Doc Section (robos:DocSection) | urn:robos:shape:DocSectionShape | dcterms:title, robos:sectionId, robos:docPage |
ADR Option (robos:ADROption) | urn:robos:shape:ADROptionShape | dcterms:title, robos:adr |