docs: BYOK messaging across marketing site and docs (BYOK 4/4)#409
Open
edspencer wants to merge 2 commits into
Open
docs: BYOK messaging across marketing site and docs (BYOK 4/4)#409edspencer wants to merge 2 commits into
edspencer wants to merge 2 commits into
Conversation
Update the marketing site for the bring-your-own-key model: the how-it-works and get-started flows now cover both key paths (web Settings -> AI Provider for chat/document generation, and bragdoc llm set for CLI extraction), the FAQ gains a "Where do I put my API key?" entry, the CLI docs note that its key config only affects local extraction, and privacy pages/diagrams state that stored keys are AES-256-GCM encrypted at rest and only ever used server-side to call the provider the user chose. Stale copy implying BragDoc supplies the AI (privacy policy AI services list, "Our AI analyzes...", self-hosting env instructions) is corrected. Technical docs get a full BYOK architecture section in ai-integration.md (resolveModelForUser flow, NoLLMConfigError -> 409 no_llm_configured, the shared @bragdoc/ai package, verify-on-save, HKDF/AES-256-GCM crypto via BYOK_ENCRYPTION_KEY, and the embeddings-stay-on-platform-key v1 decision), and database.md documents the user_llm_config table and llm_provider enum. Remaining references to the removed model singletons (routerModel, documentWritingModel, getLLM) in api-conventions.md, FEATURES.md, and reports.md are updated. BYOK_ENCRYPTION_KEY is now listed alongside the other secrets in deployment.md, architecture.md, SELF_HOSTING.md, README.md, and CLAUDE.md, with OPENAI_API_KEY clarified as demo-mode/embeddings only. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Braintrust eval reportNo experiments to report |
# Conflicts: # docs/SELF_HOSTING.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part 4 of 4 of the BYOK stack (#405). Base:
byok/3-per-user-models(#408) — merge #406, #407, #408 first. Copy only; no behavior changes.Marketing site
bragdoc llm set; the get-started flow gains an "Add Your AI API Key" step (HowTo JSON-LD updated to match).BYOK_ENCRYPTION_KEYrequired;OPENAI_API_KEYdemoted to optional (demo + embeddings only).Docs
.claude/docs/tech/ai-integration.md: new BYOK Architecture section (resolution flow, 409 contract, crypto, verify-on-save, embeddings v1 decision,@bragdoc/ai); stale getLLM/llm-router content removed.database.md:user_llm_configtable +llm_providerenum documented from the actual schema.deployment.md,architecture.md,SELF_HOSTING.md,README.md,CLAUDE.md:BYOK_ENCRYPTION_KEYin env listings;OPENAI_API_KEYannotated demo/embeddings-only; README onboarding + AI-integration sections rewritten; stale/api/cli/commitsdata-flow corrected.Verification
pnpm build6/6 green.🤖 Generated with Claude Code