docs

package
v0.13.0 Latest Latest
Warning

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

 Go to latest Published: Aug 7, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package docs embeds this framework's documentation so a tool can serve the version that is actually installed.

The problem it addresses is specific: a model's idea of a framework comes from its training data, which is some months old and averaged over every version that existed then. Fetching the docs from the internet gets whatever is on the default branch, which is a different wrong version. Compiling them into the binary means `tjo mcp` answers with the documentation for the CLI the caller is holding.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Read 

func Read(topic string) (string, error)

Read returns one document.

The name is matched against the embedded set rather than joined onto a path: a docs tool that took a path from a caller would be a file-read primitive wearing a documentation label. 

func Search(term string) map[string][]string

Search returns the topics whose text contains term, with the matching lines.

Deliberately plain: this is a handful of markdown files, and a search that needs an index is a search over a corpus that should not be embedded in a binary.

func Topics 

func Topics() []string

Topics returns the available document names, sorted.

Types

This section is empty.

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.