help

Documentation

Overview

Package help carries satelle's embedded help topics — product documentation that ships in the binary (every repo gets it) and is surfaced by BOTH the CLI (`satelle help [topic]`) and the local web server (`/help`). The topics are authored markdown under topics/, embedded as the single source so the two surfaces never drift (sty_82c456a0). Per the constitution, help-about-the- product is binary MECHANISM, not repo substrate.

Index

• type Topic
  • func Get(name string) (Topic, bool)
  • func List() []Topic

Types

type Topic

type Topic struct {
	Name  string
	Title string
	Body  string
}

Topic is one help document: a stable name (the slug), a human title (the first heading), and the raw markdown body.

func Get

func Get(name string) (Topic, bool)

Get returns the named topic and whether it exists.

func List

func List() []Topic

List returns every embedded help topic, name-sorted.