Skip to content

Commit 9c11804

Browse files
lfnovoclaude
andcommitted
docs: standardize Models navigation path to "Manage → Models"
The Models page (/settings/models) is rendered under the sidebar's "Manage" section as a sibling of Settings, not as a child of it (frontend/src/components/layout/AppSidebar.tsx). The docs mixed "Settings → Models" (~150 occurrences) with the correct "Manage → Models" (3). Standardize every doc, the backend error-message hints and the speaches compose example on "Manage → Models". CHANGELOG is historical and left untouched. No routes or behaviour changed. Follow-up to the P2 note on #1313. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012heLWVTmopC5FkipUgnvsN
1 parent bbc7d11 commit 9c11804

25 files changed

Lines changed: 153 additions & 153 deletions

docs/0-START-HERE/quick-start-cloud.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ You should see the Open Notebook interface!
8787

8888
## Step 4: Configure Your AI Provider (1 min)
8989

90-
1. Go to **Settings****Models**
90+
1. Go to **Manage****Models**
9191
2. Click **Add Credential**
9292
3. Select your provider (e.g., Anthropic, Google, Groq, OpenRouter)
9393
4. Give it a name, paste your API key
@@ -167,7 +167,7 @@ Your provider's models are now available!
167167

168168
### "Model not found" Error
169169

170-
1. Go to **Settings****Models**
170+
1. Go to **Manage****Models**
171171
2. Click **Test Connection** on your credential
172172
3. If valid, click **Discover Models****Register Models**
173173
4. Check you have credits/access for the model

docs/0-START-HERE/quick-start-external-ollama.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Wait 10-15 seconds for services to start.
109109

110110
## Step 5: Configure Ollama Provider (1 min)
111111

112-
1. Go to **Settings****Models**
112+
1. Go to **Manage****Models**
113113
2. Click **Add Credential**
114114
3. Select provider: **Ollama**
115115
4. Give it a name (e.g., "Local Ollama")
@@ -124,7 +124,7 @@ Wait 10-15 seconds for services to start.
124124

125125
## Step 6: Configure Models (1 min)
126126

127-
1. Go to **Settings****Models**
127+
1. Go to **Manage****Models**
128128
2. Set:
129129
- **Language Model**: `ollama/mistral` (or whichever model you downloaded)
130130
- **Embedding Model**: `ollama/nomic-embed-text`

docs/0-START-HERE/quick-start-openai.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ You should see the Open Notebook interface!
8585

8686
## Step 4: Configure Your OpenAI Provider (1 min)
8787

88-
1. Go to **Settings****Models**
88+
1. Go to **Manage****Models**
8989
2. Click **Add Credential**
9090
3. Select provider: **OpenAI**
9191
4. Give it a name (e.g., "My OpenAI Key")
@@ -140,7 +140,7 @@ Your OpenAI models are now available!
140140

141141
## Using Different Models
142142

143-
In your notebook, go to **Settings****Models** to choose:
143+
In your notebook, go to **Manage****Models** to choose:
144144
- `gpt-4o` - Best quality (recommended)
145145
- `gpt-4o-mini` - Fast and cheap (good for testing)
146146

@@ -160,7 +160,7 @@ Then access at `http://localhost:8503`
160160

161161
### "API key not working"
162162

163-
1. Go to **Settings** → **Models**
163+
1. Go to **Manage** → **Models**
164164
2. Click **Test Connection** on your OpenAI credential
165165
3. If it fails, verify your key at https://platform.openai.com
166166
4. Delete the credential and create a new one with the correct key

docs/1-INSTALLATION/docker-compose.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ You should see the Open Notebook interface!
126126

127127
## Step 4: Configure AI Provider (2 min)
128128

129-
1. Go to **Settings** → **Models**
129+
1. Go to **Manage** → **Models**
130130
2. Click **Add Credential**
131131
3. Select your provider (e.g., OpenAI, Anthropic, Google)
132132
4. Give it a name, paste your API key
@@ -193,7 +193,7 @@ docker exec open-notebook-local-ollama-1 ollama pull mistral
193193
```
194194

195195
Configure Ollama in the Settings UI:
196-
1. Go to **Settings** → **Models**
196+
1. Go to **Manage** → **Models**
197197
2. Click **Add Credential** → Select **Ollama**
198198
3. Enter base URL: `http://ollama:11434`
199199
4. Click **Save**, then **Test Connection**
@@ -292,7 +292,7 @@ Then access at `http://localhost:8503`
292292

293293
### Credential Issues
294294

295-
1. Go to **Settings** → **Models**
295+
1. Go to **Manage** → **Models**
296296
2. Click **Test Connection** on the credential
297297
3. If it fails, verify key at provider's website
298298
4. Check you have credits in your account
@@ -353,7 +353,7 @@ Each example includes detailed comments and usage instructions.
353353
## Next Steps
354354

355355
1. **Add Content**: Sources, notebooks, documents
356-
2. **Configure Models**: Settings → Models (choose your preferences)
356+
2. **Configure Models**: Manage → Models (choose your preferences)
357357
3. **Explore Features**: Chat, search, transformations
358358
4. **Read Guide**: [User Guide](../3-USER-GUIDE/index.md)
359359

docs/1-INSTALLATION/single-container.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ docker compose up -d
4747
Access: `http://localhost:8502`
4848

4949
Then configure your AI provider:
50-
1. Go to **Settings****Models**
50+
1. Go to **Manage****Models**
5151
2. Click **Add Credential** → Select your provider → Paste API key
5252
3. Click **Save**, then **Test Connection**
5353
4. Click **Discover Models****Register Models**
@@ -59,14 +59,14 @@ Then configure your AI provider:
5959
2. Search "Open Notebook"
6060
3. Set environment variables (at minimum: `OPEN_NOTEBOOK_ENCRYPTION_KEY`)
6161
4. Click "Deploy"
62-
5. Open the app → Go to **Settings → Models** to configure your AI provider
62+
5. Open the app → Go to **Manage → Models** to configure your AI provider
6363

6464
**Railway:**
6565
1. Create new project
6666
2. Add `lfnovo/open_notebook:v1-latest-single`
6767
3. Set environment variables (at minimum: `OPEN_NOTEBOOK_ENCRYPTION_KEY`)
6868
4. Deploy
69-
5. Open the app → Go to **Settings → Models** to configure your AI provider
69+
5. Open the app → Go to **Manage → Models** to configure your AI provider
7070

7171
**Render:**
7272
1. Create new Web Service
@@ -104,7 +104,7 @@ Open Notebook ships an EasyPanel template at [`examples/easypanel/`](https://git
104104
- **One-click (recommended):** once the template is published to the official [EasyPanel template gallery](https://github.com/easypanel-io/templates), create a new service from "Open Notebook", set an app password (or leave it blank to auto-generate one), and deploy.
105105
- **Manual:** copy `examples/easypanel/` into `templates/open-notebook` in a checkout of [`easypanel-io/templates`](https://github.com/easypanel-io/templates), run the templates playground (`npm run dev`), and create the template from the generated JSON in your EasyPanel instance.
106106

107-
After deployment, open the EasyPanel domain and configure your AI provider in **Settings → Models**. See [`examples/easypanel/README.md`](https://github.com/lfnovo/open-notebook/blob/main/examples/easypanel/README.md) for details.
107+
After deployment, open the EasyPanel domain and configure your AI provider in **Manage → Models**. See [`examples/easypanel/README.md`](https://github.com/lfnovo/open-notebook/blob/main/examples/easypanel/README.md) for details.
108108

109109
---
110110

@@ -120,7 +120,7 @@ After deployment, open the EasyPanel domain and configure your AI provider in **
120120
| `SURREAL_DATABASE` | DB name | `open_notebook` |
121121
| `API_URL` | External URL (for remote access) | `https://myapp.example.com` |
122122

123-
AI provider API keys are configured via the **Settings → Models** UI after deployment.
123+
AI provider API keys are configured via the **Manage → Models** UI after deployment.
124124

125125
---
126126

@@ -140,7 +140,7 @@ AI provider API keys are configured via the **Settings → Models** UI after dep
140140

141141
Same as Docker Compose setup - just access via `http://localhost:8502` (local) or your platform's URL (cloud).
142142

143-
1. Go to **Settings → Models** to add your AI provider credential
143+
1. Go to **Manage → Models** to add your AI provider credential
144144
2. **Test Connection** and **Discover Models**
145145

146146
See [Docker Compose](docker-compose.md) for full post-install guide.

docs/3-USER-GUIDE/api-configuration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ API keys stored in the database are encrypted using Fernet (AES-128-CBC + HMAC-S
7575
3. You'll see existing credentials and an **Add Credential** button
7676
7777
```
78-
Navigation: Settings → Models
78+
Navigation: Manage → Models
7979
```
8080
8181
---
@@ -118,7 +118,7 @@ Navigation: Settings → Models
118118

119119
### Step 1: Add Credential
120120

121-
1. Go to **Settings** → **Models**
121+
1. Go to **Manage** → **Models**
122122
2. Click **Add Credential**
123123
3. Select your provider
124124
4. Give it a descriptive name (e.g., "My OpenAI Key", "Work Anthropic")
@@ -257,7 +257,7 @@ Google Cloud's enterprise AI platform:
257257

258258
If you have existing API keys in environment variables (from a previous version):
259259

260-
1. Open **Settings → Models**
260+
1. Open **Manage → Models**
261261
2. A banner appears: "Environment variables detected"
262262
3. Click **Migrate to Database**
263263
4. Keys are copied to the database (encrypted)
@@ -292,7 +292,7 @@ If you're upgrading from an older version that used the ProviderConfig system:
292292

293293
- The migration happens automatically on first startup
294294
- Your existing configurations are converted to credentials
295-
- Check **Settings → Models** to verify the migration succeeded
295+
- Check **Manage → Models** to verify the migration succeeded
296296
- If you see issues, check the API logs for migration messages
297297

298298
---
@@ -356,7 +356,7 @@ API keys stored in the database are encrypted using Fernet (AES-128-CBC + HMAC-S
356356

357357
### Provider Shows "Not Configured"
358358

359-
1. Check if a credential exists for this provider (Settings → Models)
359+
1. Check if a credential exists for this provider (Manage → Models)
360360
2. Test the credential connection
361361
3. Verify key format matches provider requirements
362362
4. Re-discover and register models if needed

docs/3-USER-GUIDE/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ Task: "I'm exploring a concept without knowing exact words"
136136
→ Use: Search / Vector Search (semantic similarity)
137137
138138
Task: "I need to add or change my AI provider API keys"
139-
→ Use: Settings / Models (configure providers without editing files)
139+
→ Use: Manage → Models (configure providers without editing files)
140140
```
141141

142142
---

docs/4-AI-PROVIDERS/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ Any use: Free (electricity only)
245245

246246
1. **You've chosen a provider** (from this comparison guide)
247247
2. **Follow the setup guide**: [AI Providers Configuration](../5-CONFIGURATION/ai-providers.md)
248-
3. **Add your credential** in Settings → Models
248+
3. **Add your credential** in Manage → Models
249249
4. **Test your connection** and discover models
250250
5. **Start using Open Notebook!**
251251

docs/5-CONFIGURATION/advanced.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ ESPERANTO_SSL_VERIFY=false
197197

198198
### Use Different Providers for Different Tasks
199199

200-
Configure multiple AI providers via **Settings → Models**. Each provider gets its own credential:
200+
Configure multiple AI providers via **Manage → Models**. Each provider gets its own credential:
201201

202202
1. Add a credential for your main language model provider (e.g., OpenAI, Anthropic)
203203
2. Add a credential for embeddings (e.g., Voyage AI, or use the same provider)
@@ -208,7 +208,7 @@ Configure multiple AI providers via **Settings → Models**. Each provider gets
208208

209209
When using OpenAI-Compatible providers, you can configure per-service URLs in a single credential:
210210

211-
1. Go to **Settings** → **Models**
211+
1. Go to **Manage** → **Models**
212212
2. Click **Add Credential** → Select **OpenAI-Compatible**
213213
3. Configure separate URLs for LLM, Embedding, TTS, and STT
214214
4. Click **Save**, then **Test Connection**
@@ -302,7 +302,7 @@ See [Content Processing Engines → Optional engines](../3-USER-GUIDE/content-pr
302302
OPEN_NOTEBOOK_ENCRYPTION_KEY # Required for storing credentials
303303
```
304304

305-
AI provider API keys are configured via **Settings → Models** (not environment variables).
305+
AI provider API keys are configured via **Manage → Models** (not environment variables).
306306

307307
### Database
308308
```env
@@ -336,7 +336,7 @@ ESPERANTO_LLM_TIMEOUT
336336
TTS_BATCH_SIZE
337337
```
338338

339-
> **Note:** `ELEVENLABS_API_KEY` is deprecated. Configure ElevenLabs via **Settings → Models**.
339+
> **Note:** `ELEVENLABS_API_KEY` is deprecated. Configure ElevenLabs via **Manage → Models**.
340340

341341
### Debugging
342342
```env

0 commit comments

Comments
 (0)