Skip to content

docs: add package-local AI guidance - #356

Merged
linkdata merged 2 commits into
mainfrom
docs/package-local-ai-guidance
Aug 14, 2026
Merged

docs: add package-local AI guidance#356
linkdata merged 2 commits into
mainfrom
docs/package-local-ai-guidance

Conversation

@linkdata

@linkdata linkdata commented Aug 14, 2026

Copy link
Copy Markdown
Owner

Summary

  • add an indexed AI.md guide beside each of the 16 Go packages in the module
  • keep READMEs focused on human onboarding while retaining unusual caller-facing concepts in package Godoc, including tags, widget identity and multiplicity, trust boundaries, build-dependent loading, and wire framing
  • route version-matched agent guidance through the adjacent package guide while keeping the installed JaWS skill self-contained
  • repair moved references and review-sensitive details for request routes, JsVar paths, transport limits, protocol parsing, Bootstrap synchronization, and the repository test matrix

This is a documentation-only change with no runtime behavior or public API changes.

Verification

  • go generate ./...
  • gofmt -l .
  • gofumpt -l .
  • go vet ./...
  • staticcheck ./...
  • golangci-lint run
  • gosec ./...
  • go build ./...
  • JAWS_REQUIRE_NODE=1 go test -race ./...
  • JAWS_REQUIRE_NODE=1 go test ./...
  • GOARCH=386 CGO_ENABLED=0 go test ./lib/bind/... ./lib/ui/... (build-386 CI job)
  • rendered go doc review for every changed package synopsis and exported comment
  • case-sensitive package-guide completeness, local Markdown link/fragment, and stale-reference checks

@linkdata
linkdata merged commit 03c0390 into main Aug 14, 2026
7 checks passed
@linkdata
linkdata deleted the docs/package-local-ai-guidance branch August 14, 2026 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant