Machine-readable documentation
This documentation is also available as an Open Knowledge Format (OKF) bundle, version 0.2. An OKF bundle is a directory of Markdown files with YAML frontmatter. AI agents, assistants and knowledge catalogs can load it without reading the web pages.
The bundle is built from the same sources as this web site, with every release of the documentation. It always matches the pages you see here.
Download
Section titled “Download”| What | Link |
|---|---|
Archive of the whole bundle (.tar.gz) | okf.tar.gz |
| Entry point to browse the bundle online | okf/index.md |
Download and unpack the archive:
curl -fsSL https://docs.dev.logiccloud.io/okf.tar.gz | tar -xzThe archive unpacks to the directory okf/.
Content
Section titled “Content”- One concept per page. Each documentation page is one Markdown file. The
concept ID is the page path, for example
projects/runtimes/connections/mqttinokf/projects/runtimes/connections/mqtt.md. A section overview page is the file next to its directory, for exampleokf/projects.md. - Frontmatter. Each concept has
type(for exampleGuide,Connection Guide,Device Reference),title,description,tagsandresource.resourceis the URL of the page on this web site. - Index files. Each directory has an
index.mdthat lists its concepts with their descriptions. The rootokf/index.mdlists the sections in the order of the navigation of this web site and declaresokf_version. - Links. Links between pages point to other concepts in the bundle, for
example
/projects/ide.md. - Text only. The bundle contains no screenshots. Each image reference describes the screenshot in its alt text and links to the image on this web site.
Installation-specific URLs
Section titled “Installation-specific URLs”Each logiccloud installation serves its own copy of this documentation. All
URLs in the bundle (resource, image links, links to the web site) point to
the documentation host of the installation that you downloaded the bundle
from. The command above also shows the host of this installation.