Add documentation concept-gap analysis and playbook#5125
Closed
btshrewsbury-viam wants to merge 1 commit into
Closed
Add documentation concept-gap analysis and playbook#5125btshrewsbury-viam wants to merge 1 commit into
btshrewsbury-viam wants to merge 1 commit into
Conversation
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.
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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):
The documentation pages produced from this analysis are in #5131. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

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)
Notes
🤖 Generated with Claude Code