dossier

type Document struct {
	// Metadata about the Document
	FrontMatter FrontMatter
	// The text of the Document in markdown
	Body string
}

type Dossier struct {
	// The handler for interacting with a filesystem - local, remote, or otherwise.
	AFS *afero.Afero
	// The handler for interacting with documents embedded in the binary itself
	EFS *embed.FS
	// The handler for writing documents to the terminal with style
	TerminalRenderer *glamour.TermRenderer
	// The handler for parsing a markdown document with frontmatter
	MarkdownHandler *front.Matter
	// The cache of parsed documents in the Dossier
	Documents []Document
}

type DossierI interface {
	// CacheDocuments searches the Dossier's embedded file system at the specified folder path, parsing all discovered
	// markdown documents and caching them in the Dossier.
	CacheDocuments(docsFolderPath string)
	// RenderDocument returns the terminal-rendered markdown of the specified document but does not print it itself.
	RenderDocument(doc Document) (string, error)
	// FormatFrontMatter returns either the string representation of the JSON object containing the specified frontmatter
	// or the rendered markdown table representation of the frontmatter to the caller but does not print either itself.
	FormatFrontMatter(format string, docs []Document)
	// SelectDocument returns the Document which has the specified short title. If no Document matches, it errors.
	SelectDocument(shortTitle string) (document Document, err error)
	// CompleteShortTitle returns the list of short titles which are a valid match for the specified string as a prefix.
	CompleteShortTitle(match string) (titles []string)
	// ListCategories returns a slice of strings containing all of the unique categories used by the Documents in the
	// Dossier's cache.
	ListCategories(docs []Document) (categories []string)
	// ListTags returns a slice of strings containing all of the unique tags used by the Documents in the Dossier's cache.
	ListTags(docs []Document) (tags []string)
}

type FrontMatter struct {
	// The human-readable title for the document and the short name suitable for shell completion
	Title Title
	// A short synopsis of the document's contents
	Description string
	// Whether this document is Conceptual, Narrative, or something else
	Category string
	//  Freeform list of strings to help users filter and find documents
	Tags []string
}

type Title struct {
	// A short downcased string without special characters; used for topic selection
	Short string
	// The full string for the Document's title; human readable
	Long string
}