Struct DocTree 

pub struct DocTree {
    pub docs: Vec<Document>,
    pub errors: Vec<ScanError>,
    pub root: PathBuf,
}

A scanned documentation tree containing parsed documents and any scan errors.

Fields

docs: Vec<Document>

errors: Vec<ScanError>

root: PathBuf

Implementations

impl DocTree

pub fn scan(root: &Path) -> Self

Scan a directory for all markdown files and parse them.

pub fn scan_filtered(root: &Path, filter: &ScanFilter) -> Self

Scan with a filter applied.

pub fn all(&self) -> &[Document]

Get all documents.

pub fn by_category(&self, category: Category) -> Vec<&Document>

Get documents by category.

pub fn by_tag(&self, tag: &str) -> Vec<&Document>

Get documents matching a tag.

pub fn search(&self, query: &str) -> Vec<&Document>

Search documents by title or body content (case-insensitive substring match).

pub fn get(&self, rel_path: &str) -> Option<&Document>

Get a document by its path (relative to root).

pub fn counts(&self) -> HashMap<Category, usize>

Count documents by category.