Skip to content
Documentation

Open Knowledge Format Mapping

How this repository maps product documentation to Open Knowledge Format v0.2 concepts, indexes, links, and provenance.

This repository is an Open Knowledge Format (OKF) v0.2 bundle. Every product page is a concept: a UTF-8 Markdown document with YAML frontmatter, a stable bundle path, explicit provenance, and links that can be followed by both humans and agents.

OKF rule Implementation in this repository
Concept identity The relative Markdown path without the .md suffix, such as /monitoring/events.
Required concept metadata Every non-reserved Markdown file has a non-empty type.
Recommended metadata Each concept also carries title, description, tags, generated, verified, status, and sources.
Reserved files index.md files provide progressive disclosure; root log.md records bundle history.
Bundle version Root index.md declares okf_version: "0.2".
Links Concept bodies use bundle-relative paths beginning with /; generated indexes use relative links as recommended by the OKF index convention.
Trust generated.by identifies the producer and verified.by records the automated documentation validation process.
Lifecycle All current concepts use status: stable. Deprecated pages would use status: deprecated.
Provenance Concepts derive from the UEC application repository, the v7.6.0 development console, and the OKF v0.2 specification.

The bundle deliberately uses a small type vocabulary:

Type Used for
Product Guide Operator task and feature documentation
Architecture Guide System structure and data flow
Product Tour Built-in guided walkthrough
Learning Guide Conceptual learning pages
Documentation Section Folder-level orientation concepts
Reference Search, event-code, role, format, and glossary material
API Reference REST and SignalR conventions
Access Control Reference Roles, permissions, and scoping
Screenshot Catalogue Screenshot inventory and capture methodology
Release Note Published product changes
Datasheet Evaluation-oriented summary
Documentation Test Test documentation
Documentation Tool Tooling documentation

Each concept records the same three sources:

  • uec-source-repository — the internal application-whitelisting repository.
  • uec-console-v7-6-0 — the development console state after the clean pod redeploy.
  • okf-v0-2-spec — the public Open Knowledge Format v0.2 specification.

The documentation test process validates OKF conformance, local links, required metadata, timestamp offsets, progressive-disclosure indexes, and screenshot pairing. This is machine confirmation, not a claim of human product-owner review.

Run:

Terminal window
python3 tools/build_okf.py
python3 tests/test_documentation_structure.py
python3 tests/test_okf_conformance.py

The first command normalizes frontmatter, converts concept links to bundle-relative paths, regenerates indexes, and refreshes the update log. The other commands validate the documentation and OKF contract.