Skip to content

Commit 51e3e02

Browse files
committed
docs(skills): use markdown documentation links
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
1 parent 069baf9 commit 51e3e02

4 files changed

Lines changed: 15 additions & 15 deletions

File tree

skills/debug-inference/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ For local or self-hosted engines such as Ollama, vLLM, SGLang, TRT-LLM, and many
3434
- The active gateway is running
3535
- You know the failing setup, or can infer it from commands and config
3636

37-
Use `openshell --help` and nested `--help` output as the authority for the installed CLI version. Use the published [inference routing guide](https://docs.nvidia.com/openshell/latest/sandboxes/inference-routing) for route behavior and [provider management guide](https://docs.nvidia.com/openshell/latest/sandboxes/manage-providers) for credential and profile concepts.
37+
Use `openshell --help` and nested `--help` output as the authority for the installed CLI version. Use the published [inference routing guide](https://docs.nvidia.com/openshell/latest/sandboxes/inference-routing.md) for route behavior and [provider management guide](https://docs.nvidia.com/openshell/latest/sandboxes/manage-providers.md) for credential and profile concepts.
3838

3939
## Tools Available
4040

skills/debug-openshell-cluster/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ For local evaluation only, TLS may be disabled and the gateway can be reached th
3636
- For Kubernetes: `kubectl` must target the cluster that hosts OpenShell and Helm version 3 or later must be available.
3737
- For Docker or Podman: the runtime socket must be reachable from the gateway host.
3838

39-
Use `openshell --help` and nested `--help` output as the authority for the installed CLI version. Use the published [installation guide](https://docs.nvidia.com/openshell/latest/about/installation), [compute-driver reference](https://docs.nvidia.com/openshell/latest/reference/sandbox-compute-drivers), [gateway configuration reference](https://docs.nvidia.com/openshell/latest/reference/gateway-config), and [Kubernetes setup guide](https://docs.nvidia.com/openshell/latest/kubernetes/setup) as the authority for deployment and configuration behavior.
39+
Use `openshell --help` and nested `--help` output as the authority for the installed CLI version. Use the published [installation guide](https://docs.nvidia.com/openshell/latest/about/installation.md), [compute-driver reference](https://docs.nvidia.com/openshell/latest/reference/sandbox-compute-drivers.md), [gateway configuration reference](https://docs.nvidia.com/openshell/latest/reference/gateway-config.md), and [Kubernetes setup guide](https://docs.nvidia.com/openshell/latest/kubernetes/setup.md) as the authority for deployment and configuration behavior.
4040

4141
## Workflow
4242

skills/generate-sandbox-policy/SKILL.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ You may need to go back and forth a few times. Keep the loop tight:
157157

158158
## Step 3: Read the Policy Schema
159159

160-
Read the published [policy schema reference](https://docs.nvidia.com/openshell/latest/reference/policy-schema) before generating or changing a policy. Published documentation is the authority for the current schema; do not infer fields from examples in this skill.
160+
Read the published [policy schema reference](https://docs.nvidia.com/openshell/latest/reference/policy-schema.md) before generating or changing a policy. Published documentation is the authority for the current schema; do not infer fields from examples in this skill.
161161

162162
Key sections to reference:
163163
- **Policy Schema Reference** — top-level structure
@@ -169,9 +169,9 @@ Key sections to reference:
169169
- **Network Middleware** - top-level middleware configs, ordering, host selection, and failure behavior
170170
- **Validation Rules** — what combinations are valid/invalid
171171

172-
When middleware is requested, also read the published [supervisor middleware guide](https://docs.nvidia.com/openshell/latest/extensibility/supervisor-middleware).
172+
When middleware is requested, also read the published [supervisor middleware guide](https://docs.nvidia.com/openshell/latest/extensibility/supervisor-middleware.md).
173173

174-
For enforcement concepts and the shipped baseline, read [sandbox policies](https://docs.nvidia.com/openshell/latest/sandboxes/policies) and the [default policy reference](https://docs.nvidia.com/openshell/latest/reference/default-policy). The default policy is baked into the community base image (`ghcr.io/nvidia/openshell-community/sandboxes/base:latest`).
174+
For enforcement concepts and the shipped baseline, read [sandbox policies](https://docs.nvidia.com/openshell/latest/sandboxes/policies.md) and the [default policy reference](https://docs.nvidia.com/openshell/latest/reference/default-policy.md). The default policy is baked into the community base image (`ghcr.io/nvidia/openshell-community/sandboxes/base:latest`).
175175

176176
## Step 4: Choose Policy Shape
177177

@@ -632,9 +632,9 @@ private_services:
632632
633633
## Additional Resources
634634
635-
- [Policy schema](https://docs.nvidia.com/openshell/latest/reference/policy-schema)
636-
- [Sandbox policies](https://docs.nvidia.com/openshell/latest/sandboxes/policies)
637-
- [Default policy](https://docs.nvidia.com/openshell/latest/reference/default-policy)
638-
- [Supervisor middleware](https://docs.nvidia.com/openshell/latest/extensibility/supervisor-middleware)
635+
- [Policy schema](https://docs.nvidia.com/openshell/latest/reference/policy-schema.md)
636+
- [Sandbox policies](https://docs.nvidia.com/openshell/latest/sandboxes/policies.md)
637+
- [Default policy](https://docs.nvidia.com/openshell/latest/reference/default-policy.md)
638+
- [Supervisor middleware](https://docs.nvidia.com/openshell/latest/extensibility/supervisor-middleware.md)
639639
- Default policy: baked into the community base image (`ghcr.io/nvidia/openshell-community/sandboxes/base:latest`)
640640
- For translation examples from real API docs, see [examples.md](examples.md)

skills/openshell-cli/SKILL.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This is your primary fallback. Use it freely -- the CLI's help output is authori
2525

2626
## Prerequisites
2727

28-
- `openshell` is on the PATH. Follow the published [installation guide](https://docs.nvidia.com/openshell/latest/about/installation) when it is not installed.
28+
- `openshell` is on the PATH. Follow the published [installation guide](https://docs.nvidia.com/openshell/latest/about/installation.md) when it is not installed.
2929
- A reachable OpenShell gateway backed by Docker, Podman, Kubernetes, or the experimental VM driver
3030
- Docker is running only when using BYOC local builds or a Docker-backed gateway
3131
- For Kubernetes deployments: `kubectl` and Helm access to the target cluster
@@ -34,11 +34,11 @@ This is your primary fallback. Use it freely -- the CLI's help output is authori
3434

3535
Use `openshell --help` and nested `--help` output as the authority for the installed CLI version. Use the published documentation for product concepts and supported workflows:
3636

37-
- [Manage gateways](https://docs.nvidia.com/openshell/latest/sandboxes/manage-gateways)
38-
- [Manage sandboxes](https://docs.nvidia.com/openshell/latest/sandboxes/manage-sandboxes)
39-
- [Manage providers](https://docs.nvidia.com/openshell/latest/sandboxes/manage-providers)
40-
- [Sandbox policies](https://docs.nvidia.com/openshell/latest/sandboxes/policies)
41-
- [Inference routing](https://docs.nvidia.com/openshell/latest/sandboxes/inference-routing)
37+
- [Manage gateways](https://docs.nvidia.com/openshell/latest/sandboxes/manage-gateways.md)
38+
- [Manage sandboxes](https://docs.nvidia.com/openshell/latest/sandboxes/manage-sandboxes.md)
39+
- [Manage providers](https://docs.nvidia.com/openshell/latest/sandboxes/manage-providers.md)
40+
- [Sandbox policies](https://docs.nvidia.com/openshell/latest/sandboxes/policies.md)
41+
- [Inference routing](https://docs.nvidia.com/openshell/latest/sandboxes/inference-routing.md)
4242

4343
---
4444

0 commit comments

Comments
 (0)