Skip to content

Add AI/control, navigation, concepts, and manipulation sections (use-case gap closure)#5131

Draft
btshrewsbury-viam wants to merge 10 commits into
mainfrom
docs/pb11-fill-gaps
Draft

Add AI/control, navigation, concepts, and manipulation sections (use-case gap closure)#5131
btshrewsbury-viam wants to merge 10 commits into
mainfrom
docs/pb11-fill-gaps

Conversation

@btshrewsbury-viam

@btshrewsbury-viam btshrewsbury-viam commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

What

Four new documentation sections (19 pages) that close concept gaps found by a use-case → concept coverage analysis (Playbook 11) run over 50 real IoT/robotics product use-cases (VLAs, policy-based control, mobile robots, industrial manipulation, fleet ops, IoT sensing, CV, data pipelines).

  • docs/ai-control/ — inference latency, learned & policy-based control, run a VLA, integrate an LLM, simulation & sim-to-real
  • docs/navigation/ — localization, SLAM & mapping, navigate a mobile base, sensor fusion, coordinate a fleet
  • docs/manipulation/ — force & compliance control, track & pick moving objects

Concept pages placed in their topical homes (not a generic bucket): what-is-viam/platform-model, vision/confidence-scores, data/capture-frequency.

Use-cases, method, and details

The use-case analysis behind these pages (the 50 use-cases, the method, and the measured gap closure) lives in viam-code-map, not this repo: see playbook-11-example-run.md. The complete matrix (per-task concepts, gaps, learning objectives, before/after) is the spreadsheet playbook11-use-case-coverage.xlsx in the shared Drive folder.

Gap closure (63 concepts)

Coverage Before After
OWNED 29 46
SCATTERED 3 0
MISSING 14 0
No-owner gaps 17 0

The 7 BURIED concepts (kinematics, frames, motion-planning) are intentionally deferred — they are owned inside the motion-planning section, which is under active edit.

Quality

  • Every concrete claim was verified against RDK source (Playbook 1 review): async MoveOn* return types, merged configure-time selection, color_detector constant confidence, rdk:builtin:webcam triplet, etc.
  • Pages are honest that Viam does not ship built-in VLA/RL/LLM models — you bring the model in a module.
  • Passes prettier, markdownlint, vale (0 errors); 0 broken internal links; Hugo content render clean.

Notes

  • The four sections are new top-level areas; the sidebar is tree-driven, so they appear in nav via their _index.md weights.
  • These pages are agent-drafted from learning objectives and human-reviewed for accuracy and style; a maintainer pass is still recommended before merge.

🤖 Generated with Claude Code

Fills concept gaps surfaced by a use-case coverage analysis (Playbook 11):
learned/policy control, VLA and LLM integration, simulation; localization,
SLAM, base navigation, sensor fusion, multi-robot coordination; the platform
mental model, confidence scores, inference latency, capture frequency; and
force control and moving-object picking.

19 new pages across 4 sections. Passes prettier, markdownlint, and vale.
Verified against RDK source:
- MoveOnMap/MoveOnGlobe are async, return an execution ID (not a bool)
- merged movement sensor selects a source per property at configure time,
  not per-read failover
- color_detector emits a constant 1.0 confidence
- built-in webcam model triplet is rdk:builtin:webcam; clarify family slot
- scope the ML model service Infer note to ML-backed detectors
- open-vocabulary detection is a model you deploy, not a built-in
- fix SLAM and object-tracker/detect link targets
- Repoint /operate/* and nonexistent SLAM-reference links to valid targets
  (/motion-planning/frame-system/, /navigation/slam-and-mapping/, registry)
- Rename link text off 'How a robot knows where it is' (the render-link hook
  errors on link text containing 'here', which 'where' matches)
- Drop the removed navigation-service tombstone link

Validated: 0 broken internal links, vale + markdownlint clean, Hugo content
render clean (only the PostCSS asset step needs npm, handled in CI).
Documents the use-case coverage analysis behind the four new sections: the
50 IoT/robotics use-cases, the ownership-sweep method, the before/after gap
closure, and a link to the full spreadsheet.
@netlify

netlify Bot commented Jul 1, 2026

Copy link
Copy Markdown

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 8ba0459
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6a45967dd4e95900087fc8a9
😎 Deploy Preview https://deploy-preview-5131--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 44 (🔴 down 1 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Jul 1, 2026
…ts section

Per review, a concept page belongs in the section of the thing it is about,
not a catch-all bucket:
- platform-model -> what-is-viam/
- confidence-scores -> vision/ (ML/detector output)
- capture-frequency -> data/ (capture vs sensor sample rate)
- inference-latency -> ai-control/
Deletes docs/concepts/. Updates section landings, cross-links, and README.
…olute

htmltest found 8 broken targets (IA-reorg paths and relative sibling links
that don't resolve from leaf pages):
- /operate/* and /components/base/sensor-controlled/ -> real /reference and
  /hardware and /build-modules targets
- slam-and-mapping relative localization//navigate links -> absolute
  /navigation/... targets
…ents/

The /components/* alias paths render as directories without an index page.
Repoint all bare /components/ links in the new pages to the real
/reference/components/* pages (base, movement-sensor, and the index).
The reorg moved the concepts/ pages; the Netlify no-more-404 plugin flagged
the old URLs as 404s. Preserve them as Hugo aliases (301) to their new homes.
The use-case coverage analysis is methodology/run-output, not docs-site
content. It now lives in viam-code-map (playbook-11-example-run.md). This PR
keeps only the documentation pages.
@shannonbradshaw

Copy link
Copy Markdown
Collaborator

Glad to see this coming together, btshrewsbury-viam !

Two things I noted as I saw this in my inbox:

  • We don't really have support for navigation, so that section will have to wait until we've replaced all the stuff we ripped out with something we like.
  • The title AI & Learned Control doesn't give me a clear idea what that section is about.
  • I don't think manipulation is a top-level section. I think it's a subsection of motion planning.

How are you planning to assess whether we do, in fact, need a page that Claude has produced as part of this work? I don't see anything that we definitely don't need, but it's worth considering.

@ghost

Copy link
Copy Markdown

Hey btshrewsbury-viam — CI is green and no reviewer is assigned yet. Could you request one when you have a chance?

Auto-comment from overwatch. Will not re-nudge for 7 days.

@btshrewsbury-viam

btshrewsbury-viam commented Jul 6, 2026

Copy link
Copy Markdown
Collaborator Author

Shannon Bradshaw (@shannonbradshaw) I think this probably went too far, and should be a report instead of creating an automatic PR, that lets you guide what to create. I think a few pages could be useful, but as you mentioned, the organization feels off and the content needs tighter control.

@btshrewsbury-viam btshrewsbury-viam marked this pull request as draft July 6, 2026 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

safe to build This pull request is marked safe to build from a trusted zone

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants