Skip to content

Commit 864286e

Browse files
authored
docs: set the version to match the release version, add Adobe Launch tracking script, minor edits (#287)
* set version and minor edits * adobe launch tracking script
1 parent 619a058 commit 864286e

File tree

7 files changed

+26
-14
lines changed

7 files changed

+26
-14
lines changed

docs/_templates/layout.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{% extends "!layout.html" %}
2+
3+
{% block extrahead %}
4+
{{ super() }}
5+
<script src="https://assets.adobedtm.com/5d4962a43b79/c1061d2c5e7b/launch-191c2462b890.min.js"></script>
6+
{% endblock %}
7+
8+
{% block footer %}
9+
{{ super() }}
10+
<script type="text/javascript">if (typeof _satellite !== "undefined") {_satellite.pageBottom();}</script>
11+
{% endblock %}

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
this_year = date.today().year
1313
copyright = f"2025-{this_year}, NVIDIA Corporation"
1414
author = "NVIDIA Corporation"
15-
release = "0.1.0"
15+
release = "0.0.1"
1616

1717
extensions = [
1818
"myst_parser",

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Install the CLI and create your first sandbox in two commands.
138138
:link: tutorials/github-sandbox
139139
:link-type: doc
140140

141-
End-to-end guides: GitHub repo access, custom policies, and more.
141+
End-to-end guides for GitHub repo access, custom policies, and more.
142142

143143
+++
144144
{bdg-secondary}`Tutorial`
@@ -148,7 +148,7 @@ End-to-end guides: GitHub repo access, custom policies, and more.
148148
:link: sandboxes/index
149149
:link-type: doc
150150

151-
Create, manage, and customize sandboxes. Configure policies, providers, and community images.
151+
Create, manage, and customize sandboxes. Configure policies, providers, and community images for your AI agents.
152152

153153
+++
154154
{bdg-secondary}`Concept`

docs/inference/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ content:
2626

2727
# About Inference Routing
2828

29-
OpenShell handles inference in two ways:
29+
NVIDIA OpenShell handles inference traffic through two endpoints: `inference.local` and external endpoints.
30+
The following table summarizes how OpenShell handles inference traffic.
3031

3132
| Path | How It Works |
3233
|---|---|

docs/project.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "name": "openshell", "version": "0.1.0" }
1+
{ "name": "openshell", "version": "0.0.1" }

docs/sandboxes/community-sandboxes.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -87,16 +87,16 @@ The `--from` flag also accepts:
8787

8888
Each community sandbox is a directory under `sandboxes/` in the
8989
[OpenShell Community](https://github.com/NVIDIA/OpenShell-Community) repository.
90-
At minimum, a sandbox directory must contain:
90+
At minimum, a sandbox directory must contain the following files:
9191

92-
- `Dockerfile`: Defines the container image
93-
- `README.md`: Describes the sandbox and how to use it
92+
- `Dockerfile` that defines the container image.
93+
- `README.md` that describes the sandbox and how to use it.
9494

95-
Optional files:
95+
You can also include the following optional files:
9696

97-
- `policy.yaml`: Default policy applied when the sandbox launches
98-
- `skills/`: Agent skill definitions bundled with the sandbox
99-
- Startup scripts: Any scripts the Dockerfile or entrypoint invokes
97+
- `policy.yaml` that defines the default policy applied when the sandbox launches.
98+
- `skills/` that contains agent skill definitions bundled with the sandbox.
99+
- Startup scripts that are any scripts the Dockerfile or entrypoint invokes.
100100

101101
To contribute, fork the repository, add your sandbox directory, and open a pull
102102
request. Refer to the repository's

docs/versions1.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[
22
{
33
"preferred": true,
4-
"version": "0.1.0",
5-
"url": "../0.1.0/"
4+
"version": "0.0.1",
5+
"url": "../0.0.1/"
66
}
77
]

0 commit comments

Comments
 (0)