Open ContextOCTX
v0.1中文
Docs/Tooling Overview

Build and Integrate

Tooling Overview

Reference tooling, knowledge-system adapters, and core domain objects.

Status: v0.1 design baseline. This document describes the responsibility boundaries among the reference tooling, knowledge-system adapter layer, and Asset, Release, Package, and Installation.

Layers

text
Standalone octx package
  -> create_octx
  -> open_octx
  -> validate_octx
  -> CLI create / inspect / validate / unpack

Knowledge-system adapter layer
  -> import and export .octx
  -> generate missing structures
  -> materialize local indexes

Knowledge-base application
  -> preview, confirmation, installation, upgrade, rollback, and asset-management UI

octx does not depend on the SAG database or any other specific knowledge system. Using SAG as an example, zleap-sag depends on and re-exports the general OCTX entry points, while also implementing import and export adapters between .octx and SAG. Other knowledge systems can implement their own adapter layers.

Domain Objects

Asset

A knowledge asset that persists across multiple Releases. Its asset_id is generated and persisted when the Asset is first created, and must not change because the content is repackaged.

Release

A SemVer release of an Asset. Build status belongs to the producer's local records:

text
building -> ready
         -> failed

A failure does not delete the Asset. The same Asset can create another Release after the problem has been fixed.

Package

An immutable logical snapshot of a ready Release. It is identified exactly by asset_id + version + package_digest and can be represented as either a directory or a .octx ZIP archive.

Installation

The installation state of a Package in a local knowledge system. It may include locally generated structures, vectors, and product configuration, but it must not modify the original Package.

Derived Asset

A new knowledge asset created by modifying, recovering, or enriching an external Package. It receives a new asset_id and records its direct source in asset.derived_from.

Workflow Documents