Skip to content

docs(architecture): reset subsystem docs - #1184

Merged
drew merged 5 commits into
mainfrom
dn/docs-arch-updates
May 7, 2026
Merged

docs(architecture): reset subsystem docs#1184
drew merged 5 commits into
mainfrom
dn/docs-arch-updates

Conversation

@drew

@drewdrew commented May 6, 2026•
edited
Loading

Copy link
Copy Markdown
Collaborator

Summary

Architecture docs have become unwieldy. Reset the architecture directory around seven canonical subsystem docs and a new high-level architecture README. The new docs use concise maintainer narratives with Mermaid overview diagrams instead of long feature-specific source maps.

Related Issue

None.

Changes

  • Replaced the architecture docs sprawl with README.md, client.md, supervisor.md, sandbox.md, policy.md, gateway.md, providers.md, and build.md.
  • Updated AGENTS.md with subsystem ownership and architecture doc guidance for future agents.
  • Updated stale references in agent skills, examples, VM docs/scripts, and Mermaid lint comments to point at the new canonical docs.

Testing

  • mise run pre-commit passes
  • Unit tests added/updated
  • E2E tests added/updated (if applicable)

Checklist

  • Follows Conventional Commits
  • Commits are signed off (DCO)
  • Architecture docs updated (if applicable)

@drewdrew added the area:docs Documentation and examples label May 6, 2026
@drew
drew marked this pull request as draft May 6, 2026 01:48
@copy-pr-bot

copy-pr-botBot commented May 6, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@drew
drewforce-pushed the dn/docs-arch-updates branch from 7850879 to 5be6175CompareMay 6, 2026 05:12
@drew

drew commented May 6, 2026•
edited
Loading

Copy link
Copy Markdown
CollaboratorAuthor
  • review skills and make sure we aren't recommending doc updates. this should happen through AGENTS.md
  • talk about driver philosophy and how we want to integrate with the ecosystem

@drewdrew self-assigned this May 7, 2026
@drew
drewforce-pushed the dn/docs-arch-updates branch from 223ddac to 34b8507CompareMay 7, 2026 06:48
@drew
drew marked this pull request as ready for review May 7, 2026 06:49
@drew
drew merged commit cc2114e into mainMay 7, 2026
30 checks passed
@drew
drew deleted the dn/docs-arch-updates branch May 7, 2026 15:59
@drewdrew mentioned this pull request May 7, 2026
Merged
7 tasks
@zredlinedzredlined mentioned this pull request May 8, 2026
Merged
9 tasks
phamgialinhlx added a commit to phamgialinhlx/OpenShell that referenced this pull request May 21, 2026
@phamgialinhlx
docs(architecture): restore build-containers.md with maturin-action u…
6c07d53
…pdates
Upstream deleted this file in NVIDIA#1184. Re-add it with updated Python Wheels
section documenting the PyO3/maturin-action build pipeline.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TaylorMutchTaylorMutchTaylorMutch approved these changes
@mrunalpmrunalpAwaiting requested review from mrunalpmrunalp is a code owner
@maxamillionmaxamillionAwaiting requested review from maxamillionmaxamillion is a code owner
@derekwaynecarrderekwaynecarrAwaiting requested review from derekwaynecarrderekwaynecarr is a code owner

Assignees

@drewdrew

Labels

area:docsDocumentation and examples

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@drew@TaylorMutch