Skip to content

Add documentation concept-gap analysis and playbook#5125

Closed
btshrewsbury-viam wants to merge 1 commit into
mainfrom
docs/concept-gap-analysis
Closed

Add documentation concept-gap analysis and playbook#5125
btshrewsbury-viam wants to merge 1 commit into
mainfrom
docs/concept-gap-analysis

Conversation

@btshrewsbury-viam

Copy link
Copy Markdown
Collaborator

What

Two internal analysis artifacts, added at repo root (outside the Hugo docs/ content dir, so they are not published to the site):

  • docs-concept-gaps.md — a newcomer-perspective review of concept gaps across the docs, covering every top-level section.
  • analyze-gaps-playbook.md — the reusable method behind that review, so the analysis can be re-run on any doc set.

Audience lens

A software person with no robotics background learning to build a robotics product. The docs must teach two things at once: the platform (how Viam fits together) and the robotics concepts underneath it.

Headline findings (for discussion, not prescriptive)

  • The glossary owns 1 of 14 core concepts checked. Missing: pose, kinematics, PID, odometry, IMU, localization, SLAM, calibration, degrees of freedom, sensor fusion, waypoint, orientation vector, confidence score. Other sections point tooltips at these terms, but the target is empty.
  • Two correctness/safety flags that outrank the concept gaps: browser/mobile API keys presented as secret when client-bundling exposes them; no documented teleop behavior when a control link drops mid-command.
  • Several robotics concepts have no owner page (localization, sensor fusion, IMU, SLAM); others are well written but buried inside motion-planning, so a rover or data-product builder can't find them.

Notes

  • These are review/methodology docs for the team, not docs-site content — hence the root-level placement.
  • Motion-planning and vision were under active edit during the review; the file states that caveat and its coverage scope.
  • Every dramatic "no page owns / appears nowhere" claim was verified by grep before inclusion.

🤖 Generated with Claude Code

Adds a newcomer-perspective review of concept gaps across the docs
(docs-concept-gaps.md) and the reusable method behind it
(analyze-gaps-playbook.md). Analysis artifacts at repo root, outside
the Hugo content dir, so they are not published to the site.

Audience lens: a software person with no robotics background learning
to build a robotics product, where the docs must teach both the
platform and the underlying robotics concepts.
@netlify

netlify Bot commented Jul 1, 2026

Copy link
Copy Markdown

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 493439a
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6a45561b47b44500082a49fd
😎 Deploy Preview https://deploy-preview-5125--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: 39 (🟢 up 6 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
@btshrewsbury-viam

Copy link
Copy Markdown
Collaborator Author

Closing: these are methodology/analysis artifacts, not docs-site content, so they don't belong in this repo. Moved to viam-code-map (shannonbradshaw/viam-code-map#2):

  • analyze-gaps-playbook.mdplaybook-gap-analysis.md
  • docs-concept-gaps.mddocs-concept-gaps-findings.md

The documentation pages produced from this analysis are in #5131.

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.

2 participants