Clarify public profile and source docs

2026-07-04 23:21:02 +00:00
parent 296f9b1817
commit 4fe11b1b2b
3 changed files with 39 additions and 3 deletions
--- a/profiles.go
+++ b/profiles.go
@@ -10,8 +10,12 @@ import (
 	"gitea.maximumdirect.net/eric/scriptorium/internal/profile"
 )

-// OpenAICompatibleProfile returns an in-memory profile for an OpenAI-compatible
-// chat-completions endpoint.
+// OpenAICompatibleProfile returns an ordinary in-memory Profile for an
+// OpenAI-compatible chat-completions endpoint.
+//
+// It does not register global state, maintain a model catalog, or resolve
+// credentials. If APIKeyRequired is true, callers satisfy it with
+// RunRequest.APIKey. Raw API keys do not belong in profiles.
 func OpenAICompatibleProfile(cfg OpenAICompatibleProfileConfig) Profile {
 	return Profile{
 		ID:              cfg.ID,