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
47
48
49
50
51
52

//! Directory browsing data structures.
//!
//! Types for representing directory hierarchies and browsing responses
//! in the knowledge base.

use serde::{Deserialize, Serialize};

/// A node in the directory tree.
///
/// Represents a directory with its index document (if any), child directories,
/// and contained documents.
#[allow(dead_code)]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DirectoryNode {
    /// Relative path of this directory from repository root.
    pub path: String,
    /// Path to the index document (e.g., `index.md`) if present.
    pub index_document: Option<String>,
    /// Child directory paths.
    pub child_directories: Vec<String>,
    /// Documents directly in this directory.
    pub documents: Vec<DirectoryDocument>,
}

/// A document entry within a directory listing.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DirectoryDocument {
    /// Document path relative to repository root.
    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>,
    /// Optional description from front-matter.
    pub description: Option<String>,
}

/// Response for directory browse operations.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BrowseResponse {
    /// The browsed directory path.
    pub path: String,
    /// Path to the directory's index/summary document if present.
    pub summary_document: Option<String>,
    /// Subdirectory paths.
    pub directories: Vec<String>,
    /// Documents in this directory.
    pub documents: Vec<DirectoryDocument>,
    /// Whether results were truncated due to limit.
    pub truncated: bool,
}