Skip to main content

parse_documentation

seshat_scanner::documentation

Function parse_documentation 

Source 
pub fn parse_documentation(
    path: &Path,
    content: &str,
    branch_id: &BranchId,
) -> Result<DocumentationResult, ScanError>
Expand description

Parse a documentation file and extract structured knowledge nodes.

§Arguments

  • path - Relative path from the project root.
  • content - The raw file content as a string.
  • branch_id - The branch identifier for the knowledge graph nodes.

§Returns

A DocumentationResult containing the extracted knowledge nodes, or a ScanError::DocumentationError if the file cannot be parsed.