diff --git a/.agents/skills/update-docs-from-commits/SKILL.md b/.agents/skills/update-docs/SKILL.md similarity index 100% rename from .agents/skills/update-docs-from-commits/SKILL.md rename to .agents/skills/update-docs/SKILL.md diff --git a/AGENTS.md b/AGENTS.md index e352f490..089564c6 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -98,7 +98,7 @@ These pipelines connect skills into end-to-end workflows. Individual skill files - When making changes, update the relevant documentation in the `architecture/` directory. - When changes affect user-facing behavior, also update the relevant pages under `docs/`. - Follow the style guide in [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md): active voice, no unnecessary bold, no em dash overuse, no filler introductions. -- Use the `update-docs-from-commits` skill to scan recent commits and draft doc updates. +- Use the `update-docs` skill to scan recent commits and draft doc updates. ## Security diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 70bf5ef4..46e33348 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,7 +42,7 @@ Skills live in `.agents/skills/`. Your agent's harness can discover and load the | Triage | `triage-issue` | Assess, classify, and route community-filed issues | | Platform | `generate-sandbox-policy` | Generate YAML sandbox policies from requirements or API docs | | Platform | `tui-development` | Development guide for the ratatui-based terminal UI | -| Documentation | `update-docs-from-commits` | Scan recent commits and draft doc updates for user-facing changes | +| Documentation | `update-docs` | Scan recent commits and draft doc updates for user-facing changes | | Maintenance | `sync-agent-infra` | Detect and fix drift across agent-first infrastructure files | | Reference | `sbom` | Generate SBOMs and resolve dependency licenses | @@ -155,7 +155,7 @@ These are the primary `mise` tasks for day-to-day development: If your change affects user-facing behavior (new flags, changed defaults, new features, bug fixes that contradict existing docs), update the relevant pages under `docs/` in the same PR. -To ensure your doc changes follow NVIDIA documentation style, use the `update-docs-from-commits` skill. +To ensure your doc changes follow NVIDIA documentation style, use the `update-docs` skill. It scans commits, identifies doc pages that need updates, and drafts content that follows the style guide in `docs/CONTRIBUTING.md`. To build and preview docs locally: diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index e7dd0a8c..11167f48 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -8,7 +8,7 @@ If you use an AI coding agent (Cursor, Claude Code, Codex, etc.), the repo inclu | Skill | What it does | When to use | |---|---|---| -| `update-docs-from-commits` | Scans recent commits for user-facing changes and drafts doc updates. | After landing features, before a release, or to find doc gaps. | +| `update-docs` | Scans recent commits for user-facing changes and drafts doc updates. | After landing features, before a release, or to find doc gaps. | | `build-from-issue` | Plans and implements work from a GitHub issue, including doc updates. | When working from an issue that has doc impact. | The skills live in `.agents/skills/` and follow the style guide below automatically. To use one, ask your agent to run it (e.g., "catch up the docs for everything merged since v0.2.0"). @@ -110,7 +110,6 @@ These patterns are common in LLM-generated text and erode trust with technical r ### Formatting Rules - End every sentence with a period. -- One sentence per line in the source file (makes diffs readable). - Use `code` formatting for CLI commands, file paths, flags, parameter names, and values. - Use code blocks with the `console` language for CLI examples. Prefix commands with `$`: ```console diff --git a/docs/get-started/quickstart.md b/docs/get-started/quickstart.md index bd11b936..5f3607c1 100644 --- a/docs/get-started/quickstart.md +++ b/docs/get-started/quickstart.md @@ -50,8 +50,10 @@ If you prefer [uv](https://docs.astral.sh/uv/): $ uv tool install -U openshell ``` +After installing the CLI, run `openshell --help` in your terminal to see the full CLI reference, including all commands and flags. + :::{tip} -Run `openshell --help` in your terminal to see the full CLI reference, including all commands and flags. You can also clone the [NVIDIA OpenShell GitHub repository](https://github.com/NVIDIA/OpenShell) and use the `/openshell-cli` skill to load the CLI reference into your agent. +You can also clone the [NVIDIA OpenShell GitHub repository](https://github.com/NVIDIA/OpenShell) and use the `/openshell-cli` skill to load the CLI reference into your agent. ::: ## Create Your First OpenShell Sandbox diff --git a/docs/index.md b/docs/index.md index fdccda78..37d49047 100644 --- a/docs/index.md +++ b/docs/index.md @@ -99,15 +99,13 @@ Install the CLI and create your first sandbox in two commands.
-
$ uv pip install openshell
+
$ uv tool install -U openshell
$ openshell sandbox create -- claude--from openclaw-- opencode-- codex
``` -Run `openshell --help` in your terminal to see the full CLI reference, including all commands and flags. You can also clone the [OpenShell repository](https://github.com/NVIDIA/OpenShell) and use the `/openshell-cli` skill to load the CLI reference into your agent. - -Proceed to the [Quickstart](get-started/quickstart.md) for more details. +Refer to the [Quickstart](get-started/quickstart.md) for more details. --- diff --git a/docs/reference/support-matrix.md b/docs/reference/support-matrix.md index 5aee4806..96ece585 100644 --- a/docs/reference/support-matrix.md +++ b/docs/reference/support-matrix.md @@ -58,6 +58,7 @@ OpenShell enforces sandbox isolation through two Linux kernel security modules: | -------------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [Landlock LSM](https://docs.kernel.org/security/landlock.html) | Recommended | Enforces filesystem access restrictions at the kernel level. The `best_effort` compatibility mode uses the highest Landlock ABI the host kernel supports. The `hard_requirement` mode fails sandbox creation if the required ABI is unavailable. | | seccomp | Required | Filters dangerous system calls. Available on all modern Linux kernels (3.17+). | + On macOS, these kernel modules run inside the Docker Desktop Linux VM, not on the host kernel. ## Agent Compatibility