docs: comprehensive godoc documentation update across all packages #387

	name: Go

	on:
	push:
	branches: [ main ]
	pull_request:
	branches: [ main ]

	jobs:
	build:
	runs-on: ubuntu-latest
	strategy:
	matrix:
	go-version: ['1.24', '1.25']

	steps:
	- uses: actions/checkout@v4

	- name: Set up Go
	uses: actions/setup-go@v5
	with:
	go-version: ${{ matrix.go-version }}

	- name: Build
	run: go build -v ./...

	- name: Test
	run: go test -v ./...

	- name: Vet
	run: go vet ./...

	- name: Format check
	run: \|
	if [ "$(gofmt -l . \| wc -l)" -gt 0 ]; then
	echo "The following files are not formatted correctly:"
	gofmt -l .
	exit 1
	fi

Provide feedback