roadmap

package
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 13, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package roadmap generates AI-powered quarterly milestone roadmaps from a task plan. It clusters tasks into quarters with milestone groupings and per-quarter narratives, then renders the roadmap as ASCII timeline, Markdown, or HTML.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildPrompt 

func BuildPrompt(plan *pm.Plan, numQuarters int) string

BuildPrompt constructs the prompt sent to the AI provider.

func RenderASCII 

func RenderASCII(rm *Roadmap) string

RenderASCII renders the roadmap as a visual ASCII timeline for the terminal.

func RenderHTML 

func RenderHTML(rm *Roadmap) string

RenderHTML renders the roadmap as a self-contained styled HTML page.

func RenderMarkdown 

func RenderMarkdown(rm *Roadmap) string

RenderMarkdown renders the roadmap as GitHub-flavored Markdown.

func Save 

func Save(workDir string, rm *Roadmap, format Format) (string, error)

Save writes the roadmap to .cloop/roadmaps/ and returns the path.

Types

type Format 

type Format string

Format specifies the output format for the roadmap. 

const (
	FormatASCII    Format = "ascii"
	FormatMarkdown Format = "markdown"
	FormatHTML     Format = "html"
)

type Milestone 

type Milestone struct {
	Name  string    `json:"name"`
	Tasks []TaskRef `json:"tasks"`
}

Milestone groups related tasks under a named milestone within a quarter.

type Quarter 

type Quarter struct {
	Number     int         `json:"number"`     // 1-based quarter number
	Theme      string      `json:"theme"`      // short theme label, e.g. "Foundation"
	Narrative  string      `json:"narrative"`  // 2-3 sentence explanation
	Milestones []Milestone `json:"milestones"` // grouped task clusters
}

Quarter represents a single quarterly block in the roadmap.

type Roadmap 

type Roadmap struct {
	Goal      string     `json:"goal"`
	Quarters  []*Quarter `json:"quarters"`
	CreatedAt time.Time  `json:"created_at"`
}

Roadmap is the complete AI-generated quarterly roadmap.

func Build 

func Build(ctx context.Context, p provider.Provider, model string, plan *pm.Plan, numQuarters int) (*Roadmap, error)

Build calls the provider with the full plan and returns a structured Roadmap.

type TaskRef 

type TaskRef struct {
	ID    int    `json:"id"`
	Title string `json:"title"`
	Role  string `json:"role,omitempty"`
}

TaskRef is a lightweight reference to a task within a roadmap.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.