docs.go RawHistoryFolder

1package docs
2
3import (
4	"bytes"
5	"embed"
6	"io/fs"
7	"os"
8	"path/filepath"
9	"sort"
10)
11
12// embeddedDocs holds zut's user-facing documentation so installed
13// binaries do not depend on a source checkout existing on disk.
14//
15//go:embed README.md docs/*.md
16var embeddedDocs embed.FS
17
18var docFiles = map[string]string{
19	"README.md":     "README.md",
20	"extensions.md": "docs/extensions.md",
21	"rpc.md":        "docs/rpc.md",
22	"skills.md":     "docs/skills.md",
23	"themes.md":     "docs/themes.md",
24}
25
26// EnsureInstalled writes the embedded docs into $ZUT_HOME/docs and
27// returns that directory. Existing files are left untouched when their
28// content already matches the embedded copy.
29func EnsureInstalled(zutHome string) (string, error) {
30	dir := filepath.Join(zutHome, "docs")
31	if err := os.MkdirAll(dir, 0o755); err != nil {
32		return dir, err
33	}
34
35	names := make([]string, 0, len(docFiles))
36	for name := range docFiles {
37		names = append(names, name)
38	}
39	sort.Strings(names)
40
41	for _, name := range names {
42		src := docFiles[name]
43		data, err := fs.ReadFile(embeddedDocs, src)
44		if err != nil {
45			return dir, err
46		}
47		dst := filepath.Join(dir, name)
48		if existing, err := os.ReadFile(dst); err == nil && bytes.Equal(existing, data) {
49			continue
50		}
51		if err := os.WriteFile(dst, data, 0o644); err != nil {
52			return dir, err
53		}
54	}
55	return dir, nil
56}