explain

package
v0.11.0 Latest Latest
Warning

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

Go to latest
Published: Nov 18, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package explain reads the docs built into aicoded: the error catalogue, the guides, the task recipes and the changelog for agents.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Page

func Page(code string) (string, error)

Page returns the page of the error code, written in any case. It refuses, with E-CLI-001, a code that is not written like one or has no page.

func Read

func Read(topic string) (string, error)

Read returns the page of the error code, for a topic that starts with E- in any case, and otherwise the guide, task or changelog that docs.Read returns. It refuses, with E-CLI-001, a topic that has no page.

Types

type Entry

type Entry struct {
	Code, Title string
}

Entry is one page of the error catalogue.

func List

func List() ([]Entry, error)

List returns every page of the catalogue, sorted by code. Title is the text after "# CODE: " on the page's first line.

Jump to

Keyboard shortcuts

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