Skip to content

Add CLAUDE.md with pre-PR check playbook#4916

Open
btshrewsbury-viam wants to merge 54 commits intomainfrom
claude-md-playbook
Open

Add CLAUDE.md with pre-PR check playbook#4916
btshrewsbury-viam wants to merge 54 commits intomainfrom
claude-md-playbook

Conversation

@btshrewsbury-viam
Copy link
Copy Markdown
Contributor

Summary

  • Adds CLAUDE.md at the repo root documenting the four required pre-PR checks (prettier, markdownlint, vale, make build-prod) with ordering rationale and an optional browser spot-check step.
  • Intended as a handoff document for new contributors (and for Claude) so the checks get run consistently before a PR is opened.

Test plan

  • Reviewer to confirm the commands and ordering match current tooling expectations.
  • Reviewer to confirm the repo-root location is preferred vs. a subdirectory.

🤖 Generated with Claude Code

shannonbradshaw and others added 30 commits March 18, 2026 11:53
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…eline (#4845)

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…irst config (#4854)

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ring (#4858)

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: shannonbradshaw <shannon.bradshaw@gmail.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Claude <noreply@anthropic.com>
btshrewsbury-viam and others added 23 commits April 8, 2026 09:46
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: shannonbradshaw <shannon.bradshaw@gmail.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…av (#4901)

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…#4902)

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…examples (#4904)

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude <noreply@anthropic.com>
…e SLAM (#4895)

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…t-model flag (#4908)

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ng (#4906)

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…4909)

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Document the four required pre-PR checks (prettier, markdownlint, vale,
make build-prod) along with ordering rationale and an optional
browser spot-check step so Claude (and new contributors) run them
consistently before submitting a PR.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 13, 2026

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit af3fd4f
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/69e67ae45ef8b10008adaa60
😎 Deploy Preview https://deploy-preview-4916--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 (🟢 up 5 from production)
Accessibility: 99 (no change from production)
Best Practices: 83 (🔴 down 9 from production)
SEO: 89 (no change from production)
PWA: 60 (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.

Base automatically changed from new-docs-site to main April 17, 2026 16:24
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@viambot
Copy link
Copy Markdown
Member

viambot commented Apr 20, 2026

It looks like the following files may have been renamed. Please ensure you set all needed aliases:
rename docs/motion-planning/{frame-system => }/camera-calibration.md (64%) rename docs/motion-planning/{move-an-arm => }/constraints.md (48%) rename docs/{vision/3d-vision => motion-planning/frame-system-how-to}/_index.md (10%) rename docs/motion-planning/{frame-system => frame-system-how-to}/arm-fixed-camera.md (64%) rename docs/motion-planning/{frame-system => frame-system-how-to}/arm-gripper-camera.md (54%) rename docs/motion-planning/{frame-system => frame-system-how-to}/mobile-base-arm.md (54%) rename docs/motion-planning/{frame-system => frame-system-how-to}/mobile-base-sensors.md (67%) rename docs/motion-planning/{frame-system/overview.md => frame-system.md} (42%) rename docs/motion-planning/{obstacles => motion-how-to}/avoid-obstacles.md (54%) rename docs/motion-planning/{monitor-a-running-plan.md => motion-how-to/monitor-plan-execution.md} (14%) rename docs/motion-planning/{move-an-arm/move-to-pose.md => motion-how-to/move-arm-to-pose.md} (78%) rename docs/motion-planning/{move-an-arm/move-with-constraints.md => motion-how-to/move-arm-with-constraints.md} (52%) rename docs/motion-planning/{ => motion-how-to}/move-gantry.md (48%) rename docs/motion-planning/{move-an-arm => motion-how-to}/pick-an-object.md (53%) rename docs/motion-planning/{move-an-arm => motion-how-to}/place-an-object.md (36%) rename docs/motion-planning/{obstacles/overview.md => obstacles.md} (17%) rename docs/operate/hello-world/first-project/{sim-setup.md => gazebo-setup.md} (73%) rename docs/{build-apps/app-tutorials/_index.md => operate/mobility/define-dynamic-obstacles.md} (22%) rename docs/{motion-planning/move-an-arm => operate/mobility/move-arm}/_index.md (14%) rename docs/{reference/services/vision/detections-to-segments.md => operate/reference/services/vision/detector_3d_segmenter.md} (14%) rename docs/{motion-planning/obstacles/_index.md => reference/account/accounts.md} (19%) rename docs/{motion-planning/frame-system/_index.md => reference/account/organize.md} (18%) rename docs/{build-apps/tasks/_index.md => reference/advanced-modules/create-subtype.md} (13%) rename docs/reference/components/camera/{micro-rdk/_index.md => esp32-camera.md} (11%) rename docs/reference/components/camera/{micro-rdk/fake.md => fake-micro-server.md} (17%) rename docs/{build-apps/hosting/_index.md => reference/configuration/controls-package.md} (11%) rename docs/{build-apps/setup/_index.md => reference/configuration/kinematic-chain-config.md} (10%) rename docs/reference/{ => configuration}/triggers.md (97%) rename docs/{build-apps/concepts/_index.md => reference/glossary_tmp/viam-agent.md} (19%) rename docs/reference/{components/motor/micro-rdk => platform/viam-server}/_index.md (11%) rename docs/vision/{object-detection => }/act-on-detections.md (73%) rename docs/vision/{object-detection => }/alert-on-detections.md (55%) rename docs/vision/{object-detection => }/detect.md (86%) rename docs/vision/{3d-vision => }/measure-depth.md (64%) rename docs/vision/{object-detection => }/track.md (12%)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants