okc 0.1.0

A local-first tool for AI agents to browse, parse, search, and reason over Open Knowledge Format (OKF) repositories
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

//! Graph traversal data structures.
//!
//! Types for representing and traversing the document link graph.

use serde::{Deserialize, Serialize};

/// A directed edge in the document graph.
///
/// Represents a link relationship between two documents.
#[allow(dead_code)]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GraphEdge {
    /// Source document path.
    pub source: String,
    /// Target document path.
    pub target: String,
    /// Relationship type (e.g., "links_to", "references").
    pub relation: String,
}

/// Response from a graph traversal operation.
#[allow(dead_code)]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TraverseResponse {
    /// Visited nodes in traversal order.
    pub nodes: Vec<TraverseNode>,
    /// Edges traversed.
    pub edges: Vec<GraphEdge>,
    /// Whether results were truncated due to limits.
    pub truncated: bool,
}

/// A node visited during graph traversal.
#[allow(dead_code)]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TraverseNode {
    /// Document path.
    pub path: String,
    /// Optional title from front-matter.
    pub title: Option<String>,
    /// Optional concept type from front-matter.
    #[serde(rename = "type")]
    pub concept_type: Option<String>,
    /// Depth from traversal start (0 = start node).
    pub depth: usize,
}