Help us shape the future of Go! Take the 2026 Go Developer Survey

docs

package
v0.10.0 Latest Latest
Warning

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

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

Documentation

Overview

Package docs holds the pages aicoded shows: the guides, the task recipes, the error catalogue and the changelog for agents.

Index

Constants

This section is empty.

Variables

FS holds guides/<slug>.md, tasks/<slug>.md, errors/<CODE>.md for every error code, errors/README.md and changelog-agents.md.

Functions

func Read

func Read(path string) (string, error)

Read returns the text of the topic at path. It refuses, with E-CLI-001, a path that Topics does not list.

Types

type Topic

type Topic struct {
	// Path names the topic: its file under docs/ without .md, such as guides/forms, or
	// changelog.
	Path string
	// Title is the text of the file's first line, after "# ".
	Title string
	// Summary is the paragraph after the title, on one line.
	Summary string
}

Topic is a guide, a task recipe or the changelog for agents.

func Topics

func Topics() ([]Topic, error)

Topics returns the guides and the tasks, sorted by path, then the changelog.

Jump to

Keyboard shortcuts

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