dashforge

package
v0.3.0 Latest Latest
Warning

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

Go to latest
Published: Apr 26, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package dashforge provides conversion from PRISM documents to Dashforge dashboard IR.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ConvertOptions

type ConvertOptions struct {
	// BaseID is the prefix for dashboard IDs.
	BaseID string

	// DataSourcePath is the path to the PRISM JSON file (for URL data source).
	DataSourcePath string

	// GenerateGoalDashboards creates individual goal dashboards.
	GenerateGoalDashboards bool

	// Theme customizes the visual appearance.
	Theme *dashboardir.Theme
}

ConvertOptions configures the dashboard conversion.

func DefaultConvertOptions

func DefaultConvertOptions() *ConvertOptions

DefaultConvertOptions returns sensible defaults.

type DashboardSet

type DashboardSet struct {
	// Executive is the main executive summary dashboard.
	Executive *dashboardir.Dashboard `json:"executive"`

	// Maturity is the maturity scorecard dashboard.
	Maturity *dashboardir.Dashboard `json:"maturity"`

	// SLOMatrix is the SLO compliance matrix dashboard.
	SLOMatrix *dashboardir.Dashboard `json:"sloMatrix"`

	// Roadmap is the roadmap progress dashboard.
	Roadmap *dashboardir.Dashboard `json:"roadmap"`

	// Gaps is the gap analysis dashboard.
	Gaps *dashboardir.Dashboard `json:"gaps"`

	// Goals are individual goal deep-dive dashboards.
	Goals map[string]*dashboardir.Dashboard `json:"goals,omitempty"`
}

DashboardSet contains all generated dashboards for a PRISM document.

func Convert

func Convert(doc *prism.PRISMDocument, opts *ConvertOptions) (*DashboardSet, error)

Convert generates Dashforge dashboards from a PRISM document.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL