Skip to content

Commit d3d3d64

Browse files
beran-tberan-t
authored
Standardize title capitalization to sentence case (#117)
* Standardize title capitalization to sentence case across docs Converts all Title Case headings, page titles, sidebar titles, and navigation group names to sentence case — only the first word and proper nouns/acronyms remain capitalized. * Fix sentence case in Card, Accordion, Tab, Step, and Note titles Extends the capitalization fix to component title attributes (Card, Accordion, Tab, Step, Note) that render as visible section headings on the page. * Address PR review feedback - Fix missed headings in cli/auth.mdx, ci-cd.mdx - Fix missed titles in nextjs.mdx, nextjs-bun.mdx - Revert BYOC title/sidebarTitle to capitalized form (proper name) - Fix stale link text "User And Workdir" in how-it-works.mdx
1 parent 299a1d7 commit d3d3d64

48 files changed

Lines changed: 153 additions & 153 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
"icon": "book-open-cover",
2424
"groups": [
2525
{
26-
"group": "Getting Started",
26+
"group": "Getting started",
2727
"pages": [
2828
"docs",
2929
{
@@ -50,7 +50,7 @@
5050
]
5151
},
5252
{
53-
"group": "Agents in Sandbox",
53+
"group": "Agents in sandbox",
5454
"pages": [
5555
"docs/agents/amp",
5656
"docs/agents/claude-code",
@@ -59,7 +59,7 @@
5959
]
6060
},
6161
{
62-
"group": "Code Interpreting",
62+
"group": "Code interpreting",
6363
"pages": [
6464
{
6565
"group": "Analyze data with AI",
@@ -173,7 +173,7 @@
173173
]
174174
},
175175
{
176-
"group": "MCP Gateway",
176+
"group": "MCP gateway",
177177
"pages": [
178178
"docs/mcp",
179179
"docs/mcp/quickstart",
@@ -218,7 +218,7 @@
218218
]
219219
},
220220
{
221-
"anchor": "SDK Reference",
221+
"anchor": "SDK reference",
222222
"icon": "brackets-curly",
223223
"href": "https://e2b.dev/docs/sdk-reference"
224224
}

‎docs.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ print(result.stdout)
3838
```
3939
</CodeGroup>
4040

41-
## E2B Building Blocks
41+
## E2B building blocks
4242

4343
A quick overview of the core building blocks you'll interact with when using E2B.
4444

‎docs/agents/amp.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Once inside the sandbox, start AMP.
2020
amp
2121
```
2222

23-
## Run Headless
23+
## Run headless
2424

2525
Use `-x` for non-interactive mode and `--dangerously-allow-all` to auto-approve all tool calls (safe inside E2B sandboxes). AMP uses its own API key from [ampcode.com/settings](https://ampcode.com/settings).
2626

@@ -170,7 +170,7 @@ sandbox.kill()
170170
```
171171
</CodeGroup>
172172

173-
## Thread Management
173+
## Thread management
174174

175175
AMP persists conversations as threads that can be resumed or continued with follow-up tasks.
176176

@@ -236,7 +236,7 @@ sandbox.kill()
236236
```
237237
</CodeGroup>
238238

239-
## Build a Custom Template
239+
## Build a custom template
240240

241241
If you need to customize the environment (e.g. pre-install dependencies, add config files), build your own template on top of the pre-built `amp` template.
242242

@@ -295,16 +295,16 @@ python build.py
295295
```
296296
</CodeGroup>
297297

298-
## Related Guides
298+
## Related guides
299299

300300
<CardGroup cols={3}>
301-
<Card title="Sandbox Persistence" icon="clock" href="/docs/sandbox/persistence">
301+
<Card title="Sandbox persistence" icon="clock" href="/docs/sandbox/persistence">
302302
Auto-pause, resume, and manage sandbox lifecycle
303303
</Card>
304-
<Card title="Git Integration" icon="code-branch" href="/docs/sandbox/git-integration">
304+
<Card title="Git integration" icon="code-branch" href="/docs/sandbox/git-integration">
305305
Clone repos, manage branches, and push changes
306306
</Card>
307-
<Card title="SSH Access" icon="terminal" href="/docs/sandbox/ssh-access">
307+
<Card title="SSH access" icon="terminal" href="/docs/sandbox/ssh-access">
308308
Connect to the sandbox via SSH for interactive sessions
309309
</Card>
310310
</CardGroup>

‎docs/agents/claude-code.mdx‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Once inside the sandbox, start Claude Code.
2020
claude
2121
```
2222

23-
## Run Headless
23+
## Run headless
2424

2525
Use `-p` for non-interactive mode and `--dangerously-skip-permissions` to auto-approve all tool calls (safe inside E2B sandboxes).
2626

@@ -111,7 +111,7 @@ sandbox.kill()
111111
```
112112
</CodeGroup>
113113

114-
## Structured Output
114+
## Structured output
115115

116116
Use `--output-format json` to get machine-readable responses — useful for building pipelines or extracting specific results.
117117

@@ -152,7 +152,7 @@ sandbox.kill()
152152
```
153153
</CodeGroup>
154154

155-
## Streaming Output
155+
## Streaming output
156156

157157
Use `--output-format stream-json` to get a real-time JSONL event stream — including tool calls, token usage, and result metadata.
158158

@@ -210,7 +210,7 @@ sandbox.kill()
210210
```
211211
</CodeGroup>
212212

213-
## Resume a Session
213+
## Resume a session
214214

215215
Claude Code persists conversations that can be resumed with follow-up tasks using `--session-id`.
216216

@@ -274,7 +274,7 @@ sandbox.kill()
274274
```
275275
</CodeGroup>
276276

277-
## Custom System Prompt
277+
## Custom system prompt
278278

279279
Write a `CLAUDE.md` file into the sandbox for project context or use `--system-prompt` to provide task-specific instructions.
280280

@@ -324,7 +324,7 @@ sandbox.kill()
324324
```
325325
</CodeGroup>
326326

327-
## Connect MCP Tools
327+
## Connect MCP tools
328328

329329
Claude Code has built-in support for [MCP](https://modelcontextprotocol.io/). E2B provides an [MCP gateway](/docs/mcp) that gives Claude access to 200+ tools from the [Docker MCP Catalog](https://hub.docker.com/mcp).
330330

@@ -385,7 +385,7 @@ sandbox.kill()
385385
```
386386
</CodeGroup>
387387

388-
## Build a Custom Template
388+
## Build a custom template
389389

390390
If you need to customize the environment (e.g. pre-install dependencies, add config files), build your own template on top of the pre-built `claude` template.
391391

@@ -444,16 +444,16 @@ python build.py
444444
```
445445
</CodeGroup>
446446

447-
## Related Guides
447+
## Related guides
448448

449449
<CardGroup cols={3}>
450-
<Card title="MCP Tools" icon="plug" href="/docs/mcp">
450+
<Card title="MCP tools" icon="plug" href="/docs/mcp">
451451
Connect Claude Code to 200+ MCP tools
452452
</Card>
453-
<Card title="Sandbox Persistence" icon="clock" href="/docs/sandbox/persistence">
453+
<Card title="Sandbox persistence" icon="clock" href="/docs/sandbox/persistence">
454454
Auto-pause, resume, and manage sandbox lifecycle
455455
</Card>
456-
<Card title="Git Integration" icon="code-branch" href="/docs/sandbox/git-integration">
456+
<Card title="Git integration" icon="code-branch" href="/docs/sandbox/git-integration">
457457
Clone repos, manage branches, and push changes
458458
</Card>
459459
</CardGroup>

‎docs/agents/codex.mdx‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Once inside the sandbox, start Codex.
2020
codex
2121
```
2222

23-
## Run Headless
23+
## Run headless
2424

2525
Use `codex exec` for non-interactive mode and `--full-auto` to auto-approve tool calls (safe inside E2B sandboxes). Pass `--skip-git-repo-check` to bypass git directory ownership checks inside the sandbox. Pass `CODEX_API_KEY` as an environment variable.
2626

@@ -113,7 +113,7 @@ sandbox.kill()
113113
```
114114
</CodeGroup>
115115

116-
## Schema-Validated Output
116+
## Schema-validated output
117117

118118
Use `--output-schema` to constrain the agent's final response to a JSON Schema. This ensures the output conforms to a specific structure — useful for building reliable pipelines.
119119

@@ -194,7 +194,7 @@ sandbox.kill()
194194
```
195195
</CodeGroup>
196196

197-
## Streaming Events
197+
## Streaming events
198198

199199
Use `--json` to get a JSONL event stream. Each line is a JSON object representing an agent event (tool calls, file changes, messages). Progress goes to stderr; events go to stdout.
200200

@@ -244,7 +244,7 @@ sandbox.kill()
244244
```
245245
</CodeGroup>
246246

247-
## Image Input
247+
## Image input
248248

249249
Pass screenshots or design mockups with `--image` to give Codex visual context alongside the prompt.
250250

@@ -292,7 +292,7 @@ sandbox.kill()
292292
```
293293
</CodeGroup>
294294

295-
## Build a Custom Template
295+
## Build a custom template
296296

297297
If you need to customize the environment (e.g. pre-install dependencies, add config files), build your own template on top of the pre-built `codex` template.
298298

@@ -351,16 +351,16 @@ python build.py
351351
```
352352
</CodeGroup>
353353

354-
## Related Guides
354+
## Related guides
355355

356356
<CardGroup cols={3}>
357-
<Card title="Sandbox Persistence" icon="clock" href="/docs/sandbox/persistence">
357+
<Card title="Sandbox persistence" icon="clock" href="/docs/sandbox/persistence">
358358
Auto-pause, resume, and manage sandbox lifecycle
359359
</Card>
360-
<Card title="Git Integration" icon="code-branch" href="/docs/sandbox/git-integration">
360+
<Card title="Git integration" icon="code-branch" href="/docs/sandbox/git-integration">
361361
Clone repos, manage branches, and push changes
362362
</Card>
363-
<Card title="SSH Access" icon="terminal" href="/docs/sandbox/ssh-access">
363+
<Card title="SSH access" icon="terminal" href="/docs/sandbox/ssh-access">
364364
Connect to the sandbox via SSH for interactive sessions
365365
</Card>
366366
</CardGroup>

‎docs/agents/examples.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
22
url: https://github.com/e2b-dev
3-
title: All Examples
3+
title: All examples
44
icon: "github"
55
---

‎docs/agents/openclaw.mdx‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Once inside the sandbox, start OpenClaw.
2020
openclaw agent --local --message "Hello"
2121
```
2222

23-
## Run Headless
23+
## Run headless
2424

2525
Use `openclaw agent --message` for non-interactive mode. Pass `--local` to use API keys from environment variables and `--thinking` to control reasoning depth.
2626

@@ -111,7 +111,7 @@ sandbox.kill()
111111
```
112112
</CodeGroup>
113113

114-
## Structured Output
114+
## Structured output
115115

116116
Use `--json` to get machine-readable responses with structured payload and metadata.
117117

@@ -270,7 +270,7 @@ sandbox.kill()
270270
```
271271
</CodeGroup>
272272

273-
## Add Skills
273+
## Add skills
274274

275275
OpenClaw supports a [skills ecosystem](https://docs.openclaw.ai/tools/skills) via [ClawHub](https://clawhub.com). Skills are markdown files (`SKILL.md`) that extend the agent with additional tools. Install them with the `clawhub` CLI or write them directly into the workspace.
276276

@@ -382,7 +382,7 @@ sandbox.kill()
382382
```
383383
</CodeGroup>
384384

385-
## Launch the Gateway
385+
## Launch the gateway
386386

387387
OpenClaw has a built-in [web UI and chat interface](https://openclaw.ai) served by its gateway. Start it inside a sandbox and connect from your browser.
388388

@@ -426,7 +426,7 @@ print(f"Sandbox ID: {sandbox.sandbox_id}")
426426
```
427427
</CodeGroup>
428428

429-
## Build a Custom Template
429+
## Build a custom template
430430

431431
If you need to customize the environment (e.g. pre-install dependencies, add config files), build your own template on top of the pre-built `openclaw` template.
432432

@@ -495,16 +495,16 @@ python build.py
495495
```
496496
</CodeGroup>
497497

498-
## Related Guides
498+
## Related guides
499499

500500
<CardGroup cols={3}>
501-
<Card title="Sandbox Persistence" icon="clock" href="/docs/sandbox/persistence">
501+
<Card title="Sandbox persistence" icon="clock" href="/docs/sandbox/persistence">
502502
Auto-pause, resume, and manage sandbox lifecycle
503503
</Card>
504-
<Card title="Git Integration" icon="code-branch" href="/docs/sandbox/git-integration">
504+
<Card title="Git integration" icon="code-branch" href="/docs/sandbox/git-integration">
505505
Clone repos, manage branches, and push changes
506506
</Card>
507-
<Card title="SSH Access" icon="terminal" href="/docs/sandbox/ssh-access">
507+
<Card title="SSH access" icon="terminal" href="/docs/sandbox/ssh-access">
508508
Connect to the sandbox via SSH for interactive sessions
509509
</Card>
510510
</CardGroup>

‎docs/agents/opencode.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Once inside the sandbox, start OpenCode.
2020
opencode
2121
```
2222

23-
## Run Headless
23+
## Run headless
2424

2525
Use `opencode run` for non-interactive mode. Pass your LLM provider's API key as an environment variable — OpenCode supports `ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, `GEMINI_API_KEY`, and [others](https://opencode.ai/docs/config/).
2626

@@ -111,7 +111,7 @@ sandbox.kill()
111111
```
112112
</CodeGroup>
113113

114-
## Launch the Web UI
114+
## Launch the web UI
115115

116116
OpenCode has a [built-in web interface](https://opencode.ai/docs/web/). Start it inside a sandbox and connect from your browser.
117117

@@ -163,7 +163,7 @@ print(f"Sandbox ID: {sandbox.sandbox_id}")
163163
```
164164
</CodeGroup>
165165

166-
## Build a Custom Template
166+
## Build a custom template
167167

168168
If you need to customize the environment (e.g. pre-install dependencies, add config files), build your own template on top of the pre-built `opencode` template.
169169

@@ -238,16 +238,16 @@ python build.py
238238
```
239239
</CodeGroup>
240240

241-
## Related Guides
241+
## Related guides
242242

243243
<CardGroup cols={3}>
244-
<Card title="Sandbox Persistence" icon="clock" href="/docs/sandbox/persistence">
244+
<Card title="Sandbox persistence" icon="clock" href="/docs/sandbox/persistence">
245245
Auto-pause, resume, and manage sandbox lifecycle
246246
</Card>
247-
<Card title="Git Integration" icon="code-branch" href="/docs/sandbox/git-integration">
247+
<Card title="Git integration" icon="code-branch" href="/docs/sandbox/git-integration">
248248
Clone repos, manage branches, and push changes
249249
</Card>
250-
<Card title="SSH Access" icon="terminal" href="/docs/sandbox/ssh-access">
250+
<Card title="SSH access" icon="terminal" href="/docs/sandbox/ssh-access">
251251
Connect to the sandbox via SSH for interactive sessions
252252
</Card>
253253
</CardGroup>

‎docs/api-key.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "API Key"
2+
title: "API key"
33
icon: "key"
44
---
55

@@ -27,15 +27,15 @@ You can get your API key at [dashboard](https://e2b.dev/dashboard?tab=keys).
2727

2828
<br/>
2929

30-
# Access Token
30+
# Access token
3131

3232
The access token is used only in the CLI and is **not needed in the SDK**. There's no need to set it when logging into the CLI using `e2b auth login`.
3333

3434
<Note>
3535
To authenticate without the browser, you can set `E2B_ACCESS_TOKEN` as an environment variable. This is useful for CI/CD pipelines.
3636
</Note>
3737

38-
## Where to find Access token
38+
## Where to find access token
3939

4040
You can get your **Access token key** at the [dashboard](https://e2b.dev/dashboard/account).
4141

0 commit comments

Comments
 (0)