manual

package

v1.0.260758 Latest Latest Go to latest Published: Jul 30, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Details

This section is empty.

This section is empty.

func Dir() string

Dir returns ~/.config/ttypedesk/System (on-disk copy of Manual chapters).

func EnsureSystemFolder() error

EnsureSystemFolder writes embedded Manual markdown into Dir(). Existing files are overwritten so shipped docs stay current.

type App struct {
	// contains filtered or unexported fields
}

App is the in-desk Manual reader (TOC + chapter body).

func New() *App

New loads embedded chapters. Call EnsureSystemFolder separately for the on-disk copy.

func (a *App) Close() error

func (a *App) Draw(cv *uiapp.Canvas) error

func (a *App) Handle(e uiapp.Event) error

func (a *App) Init(ctx *uiapp.Context) error

type Chapter struct {
	ID    string // filename stem, e.g. 01-welcome
	Title string
	Body  string
}

Chapter is one Manual section.

func LoadChapters() ([]Chapter, error)

LoadChapters returns Manual chapters sorted by filename.