Skip to content

docs: refresh architecture and extensibility pages - #3741

Merged
drew merged 5 commits into
mainfrom
codex/docs-rust-sdk-install
Sep 27, 2026
Merged

drew merged 5 commits into
mainfrom
codex/docs-rust-sdk-install

Conversation

@drew

@drew drew commented Sep 26, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Tighten the README, architecture, and extensibility docs. The README shows how to install the Rust SDK, the architecture page leads with policy enforcement and uses consistent component names, and the extensibility overview gets a simpler diagram that shows which layers each extension point extends.

Related Issue

No issue required: documentation-only changes.

Changes

README

  • Replace the Rust SDK table description with the cargo add command and link the row to the Rust SDK guide.

Architecture (docs/about/architecture.mdx)

  • Lead with how OpenShell enforces policy (kernel-level enforcement and formally verified policy changes), reusing the README's "How it works" text.
  • Merge the gateway and workload creation sections into one paragraph under the intro.
  • Consistently bold and name the sandbox and supervisor components instead of mixing openshell-sandbox and "OpenShell Sandbox".
  • Rename "The protected channel" to "Mediated Channel", shorten the network request walkthrough, and remove the "Starting an agent safely" section.
  • Refresh the architecture diagrams: the system architecture diagram adds a policy lifecycle strip (agent proposes, gateway prover checks, you approve, policy reloads), the sandbox enforcement diagram shows policy.local propose/reload in place of the launch gate, and the remaining diagrams get matching style and alt-text updates.

Extensibility (docs/extensibility/)

  • Redraw the extension points diagram as two left-to-right rows. The data plane row shows the isolation backend and supervisor middleware; the control plane row shows gateway interceptors and drivers.
  • Add a short list to the overview intro that maps the control plane, data plane, and infrastructure layers to their extension points.
  • Move the authentication section after "Building Extensions" and rename it "Authenticating Extensions". Update links from the gateway interceptors and supervisor middleware pages to the new anchor.

Testing

  • mise run pre-commit passes
  • Diagrams render and are valid XML
  • Unit tests added/updated (not applicable to documentation changes)
  • E2E tests added/updated (not applicable)

Checklist

  • Follows Conventional Commits
  • Commits are signed off (DCO)
  • Architecture docs updated (not applicable; published docs only)

🤖 Generated with Claude Code

Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
@github-actions

Copy link
Copy Markdown

Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Redraw the extension points diagram as two left-to-right rows for the
data plane and control plane, describe which layers each extension point
extends, and move authentication after Building Extensions as
Authenticating Extensions with updated cross-page links.

Signed-off-by: Drew Newberry <anewberry@nvidia.com>
@drew drew changed the title docs(readme): show Rust SDK installation command docs: refresh architecture and extensibility pages Sep 26, 2026
@drew
drew added this pull request to the merge queue Sep 27, 2026
Merged via the queue into main with commit a3ed8c7 Sep 27, 2026
73 checks passed
@drew
drew deleted the codex/docs-rust-sdk-install branch September 27, 2026 02:28
@drew drew added this to the OpenShell 0.1.2 milestone Sep 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants