helpdoc

package

v1.13.2 Latest Latest Go to latest Published: Oct 7, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Package helpdoc provides the embedded documentation shown by the TUI.

This section is empty.

This section is empty.

This section is empty.

type DocRef struct {
	Page    string
	Heading string
}

DocRef points to a docs page. Page is a path under docs/ without .md. Released binaries keep these links, so renamed pages need a redirect.

func Manual() DocRef

func (d DocRef) URL() string

type Topic struct {
	ID      string
	Title   string
	Summary string
	Body    string
	Doc     DocRef
	// contains filtered or unexported fields
}

func Directive(name directive.Name) (Topic, bool)

Directive resolves a canonical directive name to its topic.

func Lookup(query string) (Topic, bool)

Lookup resolves a topic ID, title, alias, keyword, or an @directive.

func Search(query string) []Topic

Search returns topics whose metadata or body contains every query token.

func Suggest(query string) []Topic

Suggest matches metadata only, so completion results stay precise.

func Topics() []Topic

Topics returns every topic in display order.