Skip to content

[All Platforms][Docs] Get Started materials lack a high-level architecture diagram #2602

@Devin-Yue

Description

@Devin-Yue

Description

Description

The published NemoClaw docs site has detailed architecture diagrams on
docs/about/how-it-works.md and docs/reference/architecture.md, but the
Get Started entry pages (README, docs/index.md, docs/about/overview.md,
docs/get-started/quickstart.md) include NO high-level architecture diagram.
New users reading the Get Started materials cannot form a mental model of
the system without first navigating to deeper reference pages.
Environment
Device:        N/A (docs-site issue, observed in browser)
OS:            All client platforms (HTML content is identical across OS)
Architecture:  N/A
Node.js:       N/A
npm:           N/A
Docker:        N/A
OpenShell CLI: N/A
NemoClaw:      0.0.28 (preferred version on docs.nvidia.com/nemoclaw/)
OpenClaw:      N/A
Steps to Reproduce
1. Open https://docs.nvidia.com/nemoclaw/latest/
2. Navigate the Get Started flow: index -> Overview -> Quickstart
3. Look for a high-level architecture / system-overview diagram on each entry page
4. Open the GitHub README at https://github.com/NVIDIA/NemoClaw and look for an inline diagram
Expected Result
At least one of the Get Started entry pages (docs/index.md, docs/about/overview.md,
docs/get-started/quickstart.md, or the GitHub README.md) renders a high-level
architecture diagram showing how NemoClaw, OpenShell, the sandbox, and
inference / messaging providers fit together. New users should not have to
click into deeper reference docs to see the big picture.
Actual Result
- README.md: links to "How It Works" and "Architecture" pages only; no inline diagram.
- docs/index.md: TOC + cards layout; no diagram.
- docs/about/overview.md: prose-only - no Mermaid block, no image.
- docs/get-started/quickstart.md: no diagram.

Detailed diagrams DO exist deeper in the tree:
- docs/about/how-it-works.md  (Mermaid flowchart TB)
- docs/reference/architecture.md  (Mermaid graph LR)

These are not the entry-level pages users land on first.
Logs
Not applicable (docs content review).

Bug Details

Field Value
Priority Unprioritized
Action Dev - Open - To fix
Disposition Open issue
Module Machine Learning - NemoClaw
Keyword NemoClaw, NemoClaw_Docs, NEMOCLAW_GH_SYNC_APPROVAL, NemoClaw-SWQA-VDR

[NVB#6122203]

Metadata

Metadata

Assignees

Labels

NV QABugs found by the NVIDIA QA TeamUATIssues flagged for User Acceptance Testing.VDRLinked to VDR findingarea: docsDocumentation, examples, guides, or docs buildarea: installInstall, setup, prerequisites, or uninstall flowarea: onboardingOnboarding FSM, provider setup, sandbox launch, or first-run flow

Type

No fields configured for Bug.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions