Fix 13 app-linked anchor URLs across 10 pages#4975
Merged
shannonbradshaw merged 4 commits intoviamrobotics:mainfrom Apr 18, 2026
Merged
Fix 13 app-linked anchor URLs across 10 pages#4975shannonbradshaw merged 4 commits intoviamrobotics:mainfrom
shannonbradshaw merged 4 commits intoviamrobotics:mainfrom
Conversation
The Viam app links to docs pages with specific anchors that no longer
exist after the IA migration. This adds custom heading IDs and HTML
anchors so users land at the right section instead of the page top.
Group 1 - custom heading IDs on existing headings:
fleet/provision-devices.md: #configure-agent-provisioning
fleet/system-settings.md: #configure-networking-settings-for-tunneling
set-up-a-machine/overview.md: #sbc-setup-instructions
build-modules/write-a-logic-module.md: #program-control-logic-in-module
hardware/configure-hardware.md: #configure-hardware-on-your-machine
hardware/multi-machine/overview.md: #machine-parts
data/visualize-data.md: #teleop, #dashboard
Group 2 - alias target change + anchors:
data/capture-sync/capture-and-sync-data.md: #configure-data-capture,
#supported-resources (moved alias from data/_index.md)
Group 3 - thin pointer sections:
train/train-a-model.md: #upload-your-training-script,
#click-for-more-information-on-parsing-command-line-inputs
Group 4 - thin anchor + registry link:
hardware/configure-hardware.md: #browse-supported-hardware-by-component-api
All 13 anchors verified in built HTML output.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
viambot
added
the
safe to build
- set-up-a-machine/overview.md #sbc-setup-instructions: replace generic tip box with direct links to supported SBC setup guides - data/capture-sync/capture-and-sync-data.md #supported-resources: add table of component types and capturable methods (verified against rdk/components/*/collectors.go) - train/train-a-model.md #upload-your-training-script: add upload steps with CLI command instead of bare pointer link - train/train-a-model.md #click-for-more-information-on-parsing-command- line-inputs: add the actual flags (--dataset_file, --model_output_directory, custom --key=value args) verified against rdk/cli/ml_training.go Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Replace the hand-picked list of 6 boards in set-up-a-machine/overview.md with a single link to the device-setup landing page. The landing page lists all 9 supported SBCs plus the ESP32 microcontroller section. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs' |
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
2 participants
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.
Summary
The Viam app links to docs pages with specific
#anchorfragments that don't exist after the IA migration. Users land at the page top instead of the relevant section. This PR adds custom heading IDs and HTML anchors so the 13 anchored URLs resolve correctly.What's fixed
All 13 anchors verified in built HTML output (
make build-prod+ grep forid=).#configure-agent-provisioningfleet/provision-devices.md#configure-networking-settings-for-tunnelingfleet/system-settings.md#sbc-setup-instructionsset-up-a-machine/overview.md#program-control-logic-in-modulebuild-modules/write-a-logic-module.md#configure-hardware-on-your-machinehardware/configure-hardware.md#machine-partshardware/multi-machine/overview.md#teleopdata/visualize-data.md#dashboarddata/visualize-data.md#configure-data-capturedata/capture-sync/capture-and-sync-data.mddata/_index.md#supported-resourcesdata/capture-sync/capture-and-sync-data.md#upload-your-training-scripttrain/train-a-model.mdcustom-training-scripts#click-for-more-information-on-parsing-command-line-inputstrain/train-a-model.mdcustom-training-scripts#browse-supported-hardware-by-component-apihardware/configure-hardware.mdNot fixed (requires content work)
4 fleet API method anchors (
#getlocationmetadata,#getorganizationmetadata,#getrobotmetadata,#getrobotpartmetadata) onreference/apis/fleet.md— the methods aren't documented on that page yet.Test plan
vale0 errors on all 9 changed filesmake build-prodclean🤖 Generated with Claude Code