docs: agentOS website docs + backing examples + API reference#1504
Merged
Conversation
Documentation overhaul split out of the larger working branch (SDK/runtime changes excluded): condensed and restructured pages, removed Recommendations sections, /workspace as the default agent cwd in prose, the runnable examples/* that back the doc code blocks, and the TypeDoc API-reference setup (packages/agentos meta-package as the typedoc entry point, plus the website typedoc.json + Dockerfile/.dockerignore wiring so the API ref builds in the website-only Docker context).
NathanFlurry
added a commit
that referenced
this pull request
Jun 22, 2026
…1504) The non-docs remainder of the original #1503 working branch, rebased onto current main: the Host Tools->Bindings rename across packages/core (sidecar client, permissions, host-tools/sandbox) + crates/client + the secure-exec catalog/publish wiring. Docs + examples were split out and merged via #1504/#1506. Depends on secure-exec split/runtime-preview (@secure-exec/core 0.0.0-split-runtime-preview.5d46b14); publish.yaml clones that branch.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs-only split out of the larger working branch (#1503). Contains only docs-related changes — no SDK/runtime/crate changes.
Contents
website/— the documentation overhaul: condensed/restructured pages, removed "Recommendations" sections,/workspaceas the default agent cwd in prose, plus the docs-build wiring (typedoc.json, Dockerfile + .dockerignore so the TypeDoc API reference builds in the website-only Docker context; docs-theme pinned to v0.2.2).examples/*— the runnable examples that back the doc code blocks.packages/agentos/— the meta-package used as the TypeDoc entry point for the/apireference (7 files; not present on main).Verification
pnpm run docs:gen:ts(typedoc) generatespublic/apicleanly (0 errors).Supersedes the docs portion of #1503, which also carried unrelated SDK/runtime churn and can be closed.