Add package docs and project vision/goals (#5169)

* Add goals/design vision to contributing doc
* Add barebones package documentation

pkg/file/file.go

@@ -1,3 +1,4 @@
+// Package file provides functionality for managing, scanning and cleaning files and folders.
 package file
 
 import (

pkg/fsutil/fs.go

@@ -1,3 +1,4 @@
+// Package fsutil provides filesystem utility functions for the application.
 package fsutil
 
 import (

pkg/gallery/service.go

@@ -1,3 +1,5 @@
+// Package gallery provides application logic for managing galleries.
+// This functionality is exposed via the [Service] type.
 package gallery
 
 import (

pkg/group/doc.go

@@ -0,0 +1,2 @@
+// Package group provides the application logic for groups.
+package group

pkg/image/service.go

@@ -1,3 +1,5 @@
+// Package image provides the application logic for images.
+// The functionality is exposed via the [Service] type.
 package image
 
 import (

pkg/javascript/vm.go

@@ -1,8 +1,8 @@
+// Package javascript provides the javascript runtime for the application.
 package javascript
 
 import (
 	"fmt"
-	"net/http"
 	"os"
 	"reflect"
 
@@ -10,12 +10,9 @@ import (
 	"github.com/stashapp/stash/pkg/logger"
 )
 
+// VM is a wrapper around goja.Runtime.
 type VM struct {
 	*goja.Runtime
-
-	Progress      chan float64
-	SessionCookie *http.Cookie
-	GQLHandler    http.Handler
 }
 
 // optionalFieldNameMapper wraps a goja.FieldNameMapper and returns the field name if the wrapped mapper returns an empty string.

pkg/job/job.go

@@ -1,3 +1,4 @@
+// Package job provides the job execution and management functionality for the application.
 package job
 
 import (

pkg/match/path.go

@@ -1,3 +1,4 @@
+// Package match provides functions for matching paths to models.
 package match
 
 import (

pkg/models/doc.go

@@ -0,0 +1,2 @@
+// Package models provides application models that are used throughout the application.
+package models

pkg/models/json/json_time.go

@@ -1,3 +1,4 @@
+// Package json provides generic JSON types.
 package json
 
 import (

pkg/models/jsonschema/doc.go

@@ -0,0 +1,2 @@
+// Package jsonschema provides the JSON schema models used for importing and exporting data.
+package jsonschema

pkg/models/mocks/database.go

@@ -1,3 +1,4 @@
+// Package mocks provides mocks for various interfaces in [models].
 package mocks
 
 import (

pkg/models/paths/paths.go

@@ -1,3 +1,4 @@
+// Package paths provides functions to return paths to various resources.
 package paths
 
 import (

pkg/performer/doc.go

@@ -0,0 +1,2 @@
+// Package performer provides the application logic for performer functionality.
+package performer

pkg/pkg/pkg.go

@@ -1,3 +1,4 @@
+// Package pkg provides interfaces to interact with the package system used for plugins and scrapers.
 package pkg
 
 import (

pkg/python/exec.go

@@ -1,3 +1,4 @@
+// Package python provides utilities for working with the python executable.
 package python
 
 import (

pkg/scene/generate/generator.go

@@ -1,3 +1,4 @@
+// Package generate provides functions to generate media assets from scenes.
 package generate
 
 import (

pkg/scene/service.go

@@ -1,3 +1,5 @@
+// Package scene provides the application logic for scene functionality.
+// Most functionality is provided by [Service].
 package scene
 
 import (

pkg/scraper/scraper.go

@@ -1,3 +1,5 @@
+// Package scraper provides interfaces to interact with the scraper subsystem.
+// The [Cache] type is the main entry point to the scraper subsystem.
 package scraper
 
 import (

pkg/scraper/stashbox/stash_box.go

@@ -1,3 +1,4 @@
+// Package stashbox provides a client interface to a stash-box server instance.
 package stashbox
 
 import (

pkg/session/session.go

@@ -1,3 +1,4 @@
+// Package session provides session authentication and management for the application.
 package session
 
 import (

pkg/sliceutil/collections.go

@@ -1,3 +1,4 @@
+// Package sliceutil provides utilities for working with slices.
 package sliceutil
 
 // Index returns the first index of the provided value in the provided

pkg/sqlite/doc.go

@@ -0,0 +1,2 @@
+// Package sqlite provides interfaces to interact with the sqlite database.
+package sqlite

pkg/studio/doc.go

@@ -0,0 +1,2 @@
+// Package studio provides the application logic for studio functionality.
+package studio

pkg/tag/doc.go

@@ -0,0 +1,2 @@
+// Package tag provides application logic for tag objects.
+package tag

pkg/txn/transaction.go

@@ -1,3 +1,4 @@
+// Package txn provides functions for running transactions.
 package txn
 
 import (

pkg/utils/doc.go

@@ -0,0 +1,2 @@
+// Package utils provides various utility functions for the application.
+package utils