Skip to content

docs(architecture): reset subsystem docs#1184

Draft
drew wants to merge 3 commits intomainfrom
dn/docs-arch-updates
Draft

docs(architecture): reset subsystem docs#1184
drew wants to merge 3 commits intomainfrom
dn/docs-arch-updates

Conversation

@drew
Copy link
Copy Markdown
Collaborator

@drew drew commented May 6, 2026

Still WIP

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)

@drew drew requested review from a team, derekwaynecarr, maxamillion and mrunalp as code owners May 6, 2026 01:41
@drew drew 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 link
Copy Markdown

copy-pr-bot Bot commented May 6, 2026

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.

Signed-off-by: Drew Newberry <anewberry@nvidia.com>
@drew drew force-pushed the dn/docs-arch-updates branch from 7850879 to 5be6175 Compare May 6, 2026 05:12
@drew
Copy link
Copy Markdown
Collaborator Author

drew commented May 6, 2026

  • 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

drew added 2 commits May 6, 2026 15:56
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs Documentation and examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant