onboard

package
v0.0.6 Latest Latest
Warning

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

 Go to latest Published: Oct 16, 2026 License: MIT Imports: 12 Imported by: 0

Documentation

Overview

Package onboard implements AI-generated contributor onboarding guide generation. It collects project context from state, file tree, integrations, providers, and knowledge base, then asks the AI to produce a structured Markdown ONBOARDING.md guide for new contributors.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildPrompt 

func BuildPrompt(inp *Input) string

BuildPrompt constructs the AI prompt requesting the onboarding guide.

func Generate 

func Generate(ctx context.Context, p provider.Provider, model string, timeout time.Duration, inp *Input) (string, error)

Generate calls the AI provider with the prompt and returns the raw Markdown output.

Types

type Input 

type Input struct {
	Goal           string
	Instructions   string
	CompletedTasks []*pm.Task
	PendingTasks   []*pm.Task
	DirTree        string
	GitLog         string
	Readme         string
	Manifest       string
	Integrations   []integrations.IntegrationStatus
	ProviderName   string
	ProviderModel  string
	Profiles       []profile.Profile
	KBEntries      []*kb.Entry
}

Input holds all data collected to build the onboarding prompt.

func Collect 

func Collect(workDir string, s *state.ProjectState, cfg *config.Config, providerName, model string) (*Input, error)

Collect gathers all context needed to generate the onboarding guide.

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.