Skip to content

Docs/configure providers byok #842

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
hazratisulton wants to merge 46 commits into from
Closed

Docs/configure providers byok #842

hazratisulton wants to merge 46 commits into from

Conversation

@hazratisulton
Copy link

@hazratisulton hazratisulton commented Jun 24, 2025

Unify and Improve BYOK Documentation: "Configure Providers (BYOK)"

Summary

This PR overhauls the Bring Your Own Key (BYOK) documentation, making it user-friendly, comprehensive, and consistent across the docs site. The feature is now clearly presented as Configure Providers (BYOK) everywhere.

Key Changes

  • Rewrote the BYOK documentation page as a step-by-step guide for the Configure Providers feature, including:
    • Clear instructions for adding and managing providers and models
    • Explanations for all settings and options
    • Annotated screenshots (with placeholders for easy updates)
    • Best practices and troubleshooting tips
  • Updated all references, section titles, and sidebar entries to use the unified "Configure Providers (BYOK)" naming
  • Fixed all internal links to use /byok/ for navigation consistency
  • Removed outdated or redundant BYOK text and links from other pages
  • Ensured the documentation is clear for both new and advanced users

Motivation

  • Resolves confusion and 404s around BYOK documentation (fixes Inaccessible link from the documentation #829)
  • Provides a single, authoritative source for users to configure their own API keys and models
  • Improves overall documentation quality and user experience

Please review and suggest any further improvements!

mitya52 and others added 30 commits June 4, 2025 13:44
@mitya52
subchat model params and chat id fixes
7f2aba9
@humbertoyusta
remove locks of at commands and at command params
28ae2eb
@humbertoyusta
remove ast sled db lock
2dda8a7
@humbertoyusta
fix: don't fully postprocess file for preview
327f562
@humbertoyusta
fix: remove binary fields from source file extensions, .db .sqlite .u…
5eab584 
…asset and .mdf
@humbertoyusta
fix: only ask for definitions if file is supported by ast
3172800
@humbertoyusta
fix: remove unnecesary messages cloning
174e26d
@humbertoyusta
update tree-sitter
f759866
@humbertoyusta
add how much did it take to build AST
d7956a3
@humbertoyusta
migrating to lmdb: step 1
4bec6ff
@humbertoyusta
updating ast db to lmdb
61affa3
@humbertoyusta
fix: windows warning import
6b3ae63
@humbertoyusta
fix: keep temp dir in ast struct, so it can be cleaned up at drop
deb55b7
@humbertoyusta
new ast db usage fixes, tracing improvements and refactor usages
b4f39ee
@humbertoyusta
fix: language typos
42feca5
@humbertoyusta
fix: db env settings
a7d5b57
@humbertoyusta
fix: rm mutex from at commands after conflict resolution
9dfdf5e
@humbertoyusta
fix: small fixes from review
b796e12
@alashchev17
feat: better wording & animated confirmation card & workspace name ma…
e9c8a5b 
…tching mechanism
@mitya52
tools improvements pack (#813)
b090a89 
* tools improvements pack

* diff in cloud
@alashchev17
fix: wording & workspaces get graphql schema update
1d718b9
@alashchev17
Merge pull request #811 from smallcloudai/feat/group-tree-improvements
9925ffa 
Feature: Group tree improvements
@alashchev17
wip: refactored useIntegrations, got rid of formData handling
22fe1cd
@alashchev17
refactor(tables): better data state management & prevention of endles…
11583aa 
…s re-renderings
@mitya52
do not blacklist tools for agent mode (#818)
2152b19 
* do not blacklist tools for agent mode

* no locate
@humbertoyusta
feat: cleanup inactive shadow git repos
ef6b6bb
@humbertoyusta
feat: add cleanup of old objects in active repos
4232caa
@humbertoyusta
fix: UI friendly error for restoring old checkpoint
41bbc0d
@humbertoyusta
add test for git cleanup, so that it removes blob objects and does no…
4d35424 
…t break repo
@humbertoyusta
fix: remove shadow git repos in two steps, first rename, then remove
0cce5c9
humbertoyusta and others added 16 commits June 9, 2025 13:06
@humbertoyusta
fix: update mtime each time a checkpoint is created, so that we can c…
0aeaad2 
…heck folder age to see if repo is inactive
@humbertoyusta
fix: add abort flag to git cleanup
2458c7b
@mitya52
qwen thinking mode and some improvements on server side
a72dc36
@mitya52
add qwen reasoning option
4c7362e
@mitya52
missed enable thinking
de4f603
@mitya52
add concurrency setup in UI
b9a3006
@mitya52
allowed nctx
a59042e
@mitya52
split thinking part
660e695
@mitya52
less args
a3a1a30
@mitya52
repair invalid index and id for tool call stream
1f51d8d
@mitya52
prettier
7d5c77b
@mitya52
<think> remove if need to patch
f2f074a
@mitya52
comment on logic change
d1b09a2
@alashchev17
fix: remove multiple from mandatory toolcall.function.arguments prope…
ce7fd60 
…rties
@mitya52
cloud with non-statc caps
0d01c12
docs: unify and improve BYOK documentation as 'Configure Providers (B…
f987f31 
…YOK)'

- Rewrote and expanded BYOK documentation as a comprehensive 'Configure Providers (BYOK)' user guide
- Added step-by-step instructions, annotated screenshots, and best practices for connecting and managing API keys and models
- Updated all references, section titles, and sidebar entries to use consistent 'Configure Providers (BYOK)' naming
- Fixed sidebar and internal links to point to /byok/ for clarity and navigation
- Removed outdated or redundant BYOK text and links
@hazratisulton hazratisulton deleted the docs/configure-providers-byok branch June 24, 2025 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Inaccessible link from the documentation

5 participants

@hazratisulton @mitya52 @humbertoyusta @alashchev17