Skip to content

Commit c035227

Browse files
authored
docs: fix broken link and capitalise GitHub correctly (ai-openshell#1135)
Close the missing closing parenthesis on the Manage Providers link in github-sandbox.mdx and correct four instances of "Github" to "GitHub" across the docs. Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
1 parent 32857eb commit c035227

5 files changed

Lines changed: 5 additions & 5 deletions

File tree

‎docs/get-started/tutorials/first-network-policy.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,4 +218,4 @@ bash examples/sandbox-policy-quickstart/demo.sh
218218

219219
## Next Steps
220220

221-
- To walk through a full policy iteration with Claude Code, including diagnosing denials and applying fixes from outside the sandbox, refer to [Github Sandbox](/tutorials/github-sandbox).
221+
- To walk through a full policy iteration with Claude Code, including diagnosing denials and applying fixes from outside the sandbox, refer to [GitHub Sandbox](/tutorials/github-sandbox).

‎docs/get-started/tutorials/github-sandbox.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,4 +348,4 @@ The following resources cover related topics in greater depth:
348348

349349
- To add per-repository access levels (read-write vs read-only) or restrict to specific API methods, refer to the [Policy Schema Reference](/reference/policy-schema).
350350
- To learn the full policy iteration workflow (pull, edit, push, verify), refer to [Policies](/sandboxes/policies).
351-
- To inject credentials automatically instead of pasting tokens, refer to [Manage Providers](/sandboxes/manage-providers
351+
- To inject credentials automatically instead of pasting tokens, refer to [Manage Providers](/sandboxes/manage-providers)

‎docs/sandboxes/manage-providers.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ The following provider types are supported.
156156
| `claude` | `ANTHROPIC_API_KEY`, `CLAUDE_API_KEY` | Claude Code, Anthropic API |
157157
| `codex` | `OPENAI_API_KEY` | OpenAI Codex |
158158
| `generic` | User-defined | Any service with custom credentials |
159-
| `github` | `GITHUB_TOKEN`, `GH_TOKEN` | GitHub API, `gh` CLI — refer to [Github Sandbox](/tutorials/github-sandbox) |
159+
| `github` | `GITHUB_TOKEN`, `GH_TOKEN` | GitHub API, `gh` CLI — refer to [GitHub Sandbox](/tutorials/github-sandbox) |
160160
| `gitlab` | `GITLAB_TOKEN`, `GLAB_TOKEN`, `CI_JOB_TOKEN` | GitLab API, `glab` CLI |
161161
| `nvidia` | `NVIDIA_API_KEY` | NVIDIA API Catalog |
162162
| `openai` | `OPENAI_API_KEY` | Any OpenAI-compatible endpoint. Set `--config OPENAI_BASE_URL` to point to the provider. Refer to [Configure](/inference/configure). |

‎docs/sandboxes/manage-sandboxes.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ openshell sandbox delete my-sandbox
235235

236236
## Next Steps
237237

238-
- To follow a complete end-to-end example, refer to the [Github Sandbox](/tutorials/github-sandbox) tutorial.
238+
- To follow a complete end-to-end example, refer to the [GitHub Sandbox](/tutorials/github-sandbox) tutorial.
239239
- To supply API keys or tokens, refer to [Manage Providers](/sandboxes/manage-providers).
240240
- To control what the agent can access, refer to [Policies](/sandboxes/policies).
241241
- To use a pre-built environment, refer to the [Community Sandboxes](/sandboxes/community-sandboxes) catalog.

‎docs/sandboxes/policies.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -454,7 +454,7 @@ Endpoints without `protocol` use TCP passthrough, where the proxy allows the str
454454
Allow Claude and the GitHub CLI to reach `api.github.com` with per-path rules: read-only (GET, HEAD, OPTIONS) and GraphQL (POST) for all paths; full write access for `alpha-repo`; and create/edit issues only for `bravo-repo`. Replace `<org_name>` with your GitHub org or username.
455455

456456
<Tip>
457-
For an end-to-end walkthrough that combines this policy with a GitHub credential provider and sandbox creation, refer to [Github Sandbox](/tutorials/github-sandbox).
457+
For an end-to-end walkthrough that combines this policy with a GitHub credential provider and sandbox creation, refer to [GitHub Sandbox](/tutorials/github-sandbox).
458458

459459
</Tip>
460460

0 commit comments

Comments
 (0)