Skip to content

Update docs for Resource.Reconfigure removal [On Hold until Next RDK Release]#5111

Open
Shannon Bradshaw (shannonbradshaw) wants to merge 1 commit into
mainfrom
claude/update-reconfigure-removal-docs
Open

Update docs for Resource.Reconfigure removal [On Hold until Next RDK Release]#5111
Shannon Bradshaw (shannonbradshaw) wants to merge 1 commit into
mainfrom
claude/update-reconfigure-removal-docs

Conversation

@shannonbradshaw

Copy link
Copy Markdown
Collaborator

Source changes

Docs changes

  • docs/build-modules/module-reference.md: Go column in the defaults table no longer says "Implement Reconfigure()" — now says "Not supported for modular resources" to match the Python column. ReconfigureResource RPC marked as deprecated with explanation that viam-server now uses RemoveResource + AddResource instead.
  • docs/build-modules/platform-apis.md: Fix frontmatter description from "validate and reconfigure functions" to "validate function and constructor".
  • docs/data/filter-at-the-edge.md: Change "reconfigure method" to "constructor" when describing how to access dependencies.
  • docs/tutorials/configure/pet-photographer.md: Rename Go Reconfigure to private reconfigure since it is no longer part of the public Resource interface.

How I found these


Generated by daily docs change agent


Generated by Claude Code

rdk#6098 re-landed the removal of Reconfigure from the Resource
interface. Modular resources are now always rebuilt (Close + construct)
on config change.

- module-reference.md: Go column no longer says "Implement Reconfigure()";
  ReconfigureResource RPC marked deprecated
- platform-apis.md: fix frontmatter description
- filter-at-the-edge.md: change "reconfigure method" to "constructor"
- pet-photographer.md: rename Go Reconfigure to private reconfigure

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018RBJg5huGPhkJmhpnR87Ea
@netlify

netlify Bot commented Jun 30, 2026

Copy link
Copy Markdown

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit ac86ee4
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6a43ce366b7ac5000854cd4b
😎 Deploy Preview https://deploy-preview-5111--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: 42 (no change 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 Jun 30, 2026
@btshrewsbury-viam btshrewsbury-viam self-assigned this Jun 30, 2026
@btshrewsbury-viam btshrewsbury-viam changed the title Update docs for Resource.Reconfigure removal Update docs for Resource.Reconfigure removal [On Hold until Next RDK Release] Jun 30, 2026
@btshrewsbury-viam

Copy link
Copy Markdown
Collaborator

Overlaps with #5042 — these should be consolidated. Both PRs rewrite the same module-reference.md defaults table and the same ReconfigureResource RPC row for the same Reconfigure removal (rdk #5944 / reland #6098), with conflicting wording and different base-table states. They can't both merge cleanly; recommend folding into one PR and closing the other.

The release gate isn't met yet. As of June 30, latest rdk release is still v0.132.0 (June 23), which still has Reconfigure in the Resource interface (resource.go@v0.132.0:77); #6098 is 12 commits after that tag. Keep both on hold until v0.133.0 is tagged AND contains #6098 — this PR's "[On Hold until Next RDK Release]" framing is the correct one. Merging before then makes the docs wrong for the current shipped SDK.

If reconciling: this PR covers more files (platform-apis, filter-at-the-edge, pet-photographer) and has the more accurate ReconfigureResource description — on main, viam-server no longer calls ReconfigureResource; it uses RemoveResource + AddResource (no call site remains in module/modmanager/manager.go). Prefer #5042's table treatment though: dropping the in-place row and stating "always rebuilds; not supported in any language" in prose is cleaner than a "Not supported" row. Two fixes for this PR: (1) module.proto has no [deprecated = true] on ReconfigureResource, so phrase it as "no longer called by viam-server" rather than "Deprecated."; (2) the pet-photographer.md code change won't compile on the current released SDK — colorFilterCam embeds only resource.Named, so removing the public Reconfigure leaves it without that interface method (would need resource.AlwaysRebuild embedded). That resolves itself once the removal ships, but confirm against v0.133.0.

@shannonbradshaw

Copy link
Copy Markdown
Collaborator Author

Good catches on all three points — agreed.

  1. Overlap with Update docs for Resource.Reconfigure removal [On Hold until v0.133.0] #5042: This PR was created from a backlog item that didn't track Update docs for Resource.Reconfigure removal [On Hold until v0.133.0] #5042's existence (the earlier PR was opened from a different session). They should be consolidated into one PR. This PR covers more files (platform-apis, filter-at-the-edge, pet-photographer) while Update docs for Resource.Reconfigure removal [On Hold until v0.133.0] #5042 covers the sensor override file and has the cleaner table treatment. I'll defer to your judgment on which to fold into which.

  2. Release gate: Correct — rdk#6098 hasn't shipped in a tagged release yet. Putting this on hold until v0.133.0 contains the removal is the right call.

  3. Specific fixes when reconciling:

    • Will change _Deprecated._ to "no longer called by viam-server" since the proto doesn't carry [deprecated = true].
    • The pet-photographer.md Reconfigurereconfigure rename should wait for the release that removes it from the interface, as noted.

Marking this on hold. Happy to close this in favor of folding the additional file coverage into #5042, or vice versa — whichever is easier for you.


Generated by Claude Code

Shannon Bradshaw (shannonbradshaw) pushed a commit that referenced this pull request Jun 30, 2026
…otographer fixes; fix ReconfigureResource wording

Incorporates changes from #5111 so both PRs can be consolidated:
- platform-apis.md: fix frontmatter "reconfigure functions" to "constructor"
- filter-at-the-edge.md: fix "reconfigure method" to "constructor"
- pet-photographer.md: Reconfigure -> reconfigure (private method)
- module-reference.md: ReconfigureResource RPC is no longer called by
  viam-server (uses RemoveResource + AddResource instead); not labeled
  Deprecated since proto has no [deprecated = true]

Per btshrewsbury-viam review: gate merge on v0.133.0 containing rdk#6098.

https://claude.ai/code/session_01Xd7GAtzjRzypiJK1amk4Uu
@viamrobotics-overwatch

Copy link
Copy Markdown

Hey Shannon Bradshaw (@shannonbradshaw) — 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.

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.

4 participants