docs

package
v0.0.5 Latest Latest
Warning

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

 Go to latest Published: Jun 2, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package docs provides the packaged markdown reference topics exposed by the agent-factory CLI docs surface.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IndexMarkdown added in v0.0.5 

func IndexMarkdown(cliName string) string

IndexMarkdown returns a terminal-friendly index of packaged docs topics.

func Markdown 

func Markdown(topic string) (string, error)

Markdown returns the embedded markdown page for one supported topic.

func QuickStartMarkdown added in v0.0.5 

func QuickStartMarkdown(cliName string) string

QuickStartMarkdown returns the quick-start blurb printed before the docs index.

func SupportedTopicCommands added in v0.0.5 

func SupportedTopicCommands() []string

SupportedTopicCommands returns canonical topic names and compatibility aliases accepted by the CLI as subcommands.

func SupportedTopics 

func SupportedTopics() []string

SupportedTopics returns the fixed docs topics exposed by the packaged CLI docs surface in display order.

Types

type Topic 

type Topic string

Topic is one stable docs topic name exposed by the CLI. 

const (
	TopicAgents             Topic = "agents"
	TopicAuthoringFactories Topic = "authoring-factories"
	TopicConfig             Topic = "config"
	TopicMockWorkers        Topic = "mock-workers"
	TopicRecordReplay       Topic = "record-replay"
	TopicGuards             Topic = "guards"
	TopicRelationships      Topic = "relationships"
	TopicWork               Topic = "work"
	TopicSessions           Topic = "sessions"
	TopicWorkstations       Topic = "workstations"
	TopicWorkers            Topic = "workers"
	TopicResources          Topic = "resources"
	TopicModels             Topic = "models"
	TopicBatchInputs        Topic = "batch-inputs"
	TopicTemplates          Topic = "templates"
)
const (
	TopicWorkstationAlias Topic = "workstation"
	TopicBatchWorkAlias   Topic = "batch-work"
)

type TopicSummary added in v0.0.5 

type TopicSummary struct {
	Name        string
	Description string
}

TopicSummary describes one canonical packaged docs topic for index output.

func TopicSummaries added in v0.0.5 

func TopicSummaries() []TopicSummary

TopicSummaries returns canonical packaged docs topic metadata in display order.

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.