Robotics: update cross-references in Tutorials to MyST standards
#360 opened on Jul 22, 2026
Repository metrics
- Stars
- (119 stars)
- PR merge metrics
- (PR metrics pending)
Description
The mentor for this issue is @geofreynyaga
Background
Tutorial pages use relative Markdown links to other documentation pages. For example, in docs/tutorials/observability/deploy-cos-for-robotics-agent-on-your-robot.md, Host a basic file server for your rosbags links to ../../how-to-guides/operation/deploy-caddy.md. Replace these with MyST references so links are resilient to file moves and use meaningful page or section anchors.
Scope is limited to docs/tutorials/ directory and its files.
Task
- Review documentation-page links in
docs/tutorials/that use relative paths. Do not convert image or other asset paths. - Replace each relative documentation link with a MyST reference. Use a page's level-1 heading when the link is to the whole page; otherwise, reference the relevant section heading.
- Add labels where required. For level-1 headings, use the
folder-subfolder-title-slugconvention, with concise, unique lowercase slugs; for the linked Caddy page in the example above, use(how-to-guides-operation-deploy-caddy)=. - Check every new or changed label manually: it must be meaningful, unique, and follow the convention.
- Run
make clean, thenmake run. In the local site, manually click every changed link and confirm it reaches the intended page or section. - Run
make linkcheck; it must pass. - Open a pull request against the repository and sign the Canonical contributor license agreement.
Outcome
Documentation-page links in Tutorials use MyST references, their anchors follow a consistent convention, and all changed links have been manually verified.