docs

package
v0.4.9 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DocumentationEntry

type DocumentationEntry struct {
	Title       string
	Description string
	Path        string
	Category    string
	Tags        []string
}

DocumentationEntry represents a documentation entry

type LLMConfig

type LLMConfig struct {
	OutputDir  string // Output directory
	IncludeAll bool   // Include all files, not just curated
	Title      string // Documentation title
	BaseURL    string // Base URL for links
	Version    string // Version string
}

LLMConfig holds configuration for LLM documentation

type LLMGenerator

type LLMGenerator struct {
	// contains filtered or unexported fields
}

LLMGenerator generates machine-readable documentation

func NewLLMGenerator

func NewLLMGenerator(config *LLMConfig) *LLMGenerator

NewLLMGenerator creates a new LLM documentation generator

func (*LLMGenerator) GenerateIndex

func (g *LLMGenerator) GenerateIndex() (string, error)

GenerateIndex generates a search-friendly index

func (*LLMGenerator) GenerateLLMsFullTxt

func (g *LLMGenerator) GenerateLLMsFullTxt() (string, error)

GenerateLLMsFullTxt generates the full documentation (llms-full.txt)

func (*LLMGenerator) GenerateLLMsTxt

func (g *LLMGenerator) GenerateLLMsTxt() (string, error)

GenerateLLMsTxt generates the llms.txt file (curated index)

func (*LLMGenerator) WriteFiles

func (g *LLMGenerator) WriteFiles() error

WriteFiles writes the documentation files

Jump to

Keyboard shortcuts

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