Skip to main content

Module roadmap

Module roadmap 

Source
Expand description

ROADMAP.md Parser and Sync Engine

Parses ROADMAP.md format into structured roadmap items, handles metadata comments for sync, and provides utilities for bidirectional synchronization with GitHub Issues.

Structs§

ItemMetadata
Metadata for checkbox items
ParsedRoadmap
Result of parsing ROADMAP.md
RoadmapCheckItem
Represents a checkbox item (- [ ] or - [x])
RoadmapSection
Represents a parsed roadmap section (## or ### header)
SectionMetadata
Metadata embedded in HTML comments

Enums§

RoadmapError
Error type for roadmap operations

Functions§

compute_hash
Compute SHA256 hash of content
generate_issue_body
Generate GitHub issue body from a roadmap section
generate_item_metadata
Generate item metadata comment
generate_section_metadata
Generate section metadata comment
parse_issue_body_checkboxes
Parse checkbox state from issue body
parse_item_metadata
Parse item metadata from HTML comment Format:
parse_roadmap
Parse ROADMAP.md file into structured sections
parse_section_metadata
Parse section metadata from HTML comment Format:
write_roadmap_with_metadata
Rewrite ROADMAP.md with updated metadata

Type Aliases§

Result