Skip to content

Commit cb29b77

Browse files
authored
docs(docs): fix links to files outside documentation routes (#1648)
# Pull Request ## Description <!-- Brief description of changes. Link related issues using Closes #123 --> Fix the Docusaurus build failure from [run 35765089888](https://github.com/microsoft/physical-ai-toolchain/actions/runs/35765089888) by marking repository-external documentation links with the supported `pathname://` protocol. Six links across five documentation pages now bypass same-plugin Markdown resolution while preserving their link text, target paths, and fragments. Strict broken-link enforcement remains enabled; no Docusaurus configuration, workflow, dependency, test, or generated file changes are included. Closes #1647 ## Type of Change <!-- Mark relevant options with [x] --> - [x] 🐛 Bug fix (non-breaking change fixing an issue) - [x] ✨ New feature (non-breaking change adding functionality) - [ ] 💥 Breaking change (fix or feature causing existing functionality to change) - [x] 📚 Documentation update - [ ] 🏗️ Infrastructure change (Terraform/IaC) - [ ] ♻️ Refactoring (no functional changes) ## Component(s) Affected <!-- Mark all that apply --> - [ ] `infrastructure/terraform/prerequisites/` - Azure subscription setup - [ ] `infrastructure/terraform/` - Terraform infrastructure - [ ] `infrastructure/setup/` - OSMO control plane / Helm - [x] `workflows/` - Training and evaluation workflows - [ ] `training/` - Training pipelines and scripts - [x] `docs/` - Documentation ## Testing Performed <!-- Describe testing. Check applicable items --> - [ ] Terraform `plan` reviewed (no unexpected changes) - [ ] Terraform `apply` tested in dev environment - [ ] Training scripts tested locally with Isaac Sim - [ ] OSMO workflow submitted successfully - [ ] Smoke tests passed (`smoke_test_azure.py`) | Check | Result | |-------|--------| | Docusaurus unit tests | 5 suites and 20 tests passed | | Docusaurus production build | Client and server compiled; static files generated | | Markdown lint | 227 files checked; 0 issues | | Spell check | 901 files checked; 0 issues | | `git diff --check origin/main...HEAD` | Passed | The production build continues to report three pre-existing, non-fatal anchor warnings outside this change. ## Documentation Impact <!-- Select one --> - [ ] No documentation changes needed - [x] Documentation updated in this PR - [ ] Documentation issue filed ## Bug Fix Checklist *Complete this section for bug fix PRs. Skip for other contribution types.* - [ ] Linked to issue being fixed - [ ] Regression test included, OR - [x] Justification for no regression test: The existing Docusaurus production build is the regression gate for static link resolution and passed with strict broken-link checks enabled. ## Checklist - [x] My code follows the [project conventions](copilot-instructions.md) - [x] Commit messages follow [conventional commit format](instructions/commit-message.instructions.md) - [x] I have performed a self-review - [x] Documentation impact assessed above - [x] No new linting warnings introduced
1 parent 7ab7461 commit cb29b77

5 files changed

Lines changed: 11 additions & 11 deletions

File tree

docs/contributing/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ sidebar_position: 1
33
title: Contributing to Physical AI Toolchain
44
description: Guide for contributing including prerequisites, deployment validation, and style conventions
55
author: Microsoft Robotics-AI Team
6-
ms.date: 2026-09-21
6+
ms.date: 2026-09-22
77
ms.topic: how-to
88
keywords:
99
- azure
@@ -114,7 +114,7 @@ This project uses [Conventional Commits](https://www.conventionalcommits.org/):
114114

115115
Types: `feat`, `fix`, `refactor`, `perf`, `style`, `test`, `docs`, `build`, `ops`, `chore`, `security`.
116116

117-
Select a scope from the [commit-message instructions](../../.github/instructions/commit-message.instructions.md#scopes), such as `infrastructure`, `training`, `scripts`, `docs`, or `build`.
117+
Select a scope from the [commit-message instructions](pathname://../../.github/instructions/commit-message.instructions.md#scopes), such as `infrastructure`, `training`, `scripts`, `docs`, or `build`.
118118

119119
Use imperative descriptions and keep the subject under 100 bytes. For larger changes, use at most five body bullets totaling fewer than 300 bytes. End with an emoji attribution footer followed by `- Generated by Copilot`.
120120

@@ -189,7 +189,7 @@ npm run lint:sh
189189
npm run lint:md
190190
```
191191

192-
Run the applicable tests listed in [Testing Requirements](../../CONTRIBUTING.md#testing-requirements). Deployment validation does not replace automated tests.
192+
Run the applicable tests listed in [Testing Requirements](pathname://../../CONTRIBUTING.md#testing-requirements). Deployment validation does not replace automated tests.
193193

194194
For complete validation procedures, testing templates, and cost optimization strategies, see [Deployment Validation Guide](deployment-validation.md).
195195

docs/contributing/ROADMAP.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ sidebar_position: 3
33
title: "Physical AI Toolchain Roadmap"
44
description: "Project roadmap covering documentation, testing, CI/CD, governance, security, and OpenSSF compliance through Q1 2027."
55
author: wberry
6-
ms.date: 2026-09-21
6+
ms.date: 2026-09-22
77
ms.topic: reference
88
keywords:
99
- roadmap
@@ -32,7 +32,7 @@ Tier IDs, stage names, boundaries, and the fleet vocabulary are defined once in
3232
3333
## Current State
3434

35-
The latest release recorded in [CHANGELOG.md](../../CHANGELOG.md) is v0.8.0, dated 2026-05-08; `package.json` also reports 0.8.0.
35+
The latest release recorded in [CHANGELOG.md](pathname://../../CHANGELOG.md) is v0.8.0, dated 2026-05-08; `package.json` also reports 0.8.0.
3636
Releases v0.2.0 through v0.8.0 are recorded, but release numbers alone do not establish completion of every originally planned deliverable.
3737
The priorities, success-metric baseline, and timeline below retain the historical planning record. OpenSSF percentages and milestone issue completion were not reassessed during this source review; future tier and autonomy plans are not marked shipped by this update.
3838

docs/contributing/deployment-validation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ sidebar_position: 8
33
title: Deployment Validation Guide
44
description: Validation levels, testing templates, and cost optimization for contribution testing
55
author: Microsoft Robotics-AI Team
6-
ms.date: 2026-09-21
6+
ms.date: 2026-09-22
77
ms.topic: how-to
88
---
99

@@ -36,7 +36,7 @@ npm run lint:sh
3636
npm run lint:md
3737
```
3838

39-
Run the applicable component tests as described in [Testing Requirements](../../CONTRIBUTING.md#testing-requirements). Static checks alone do not replace tests for code changes.
39+
Run the applicable component tests as described in [Testing Requirements](pathname://../../CONTRIBUTING.md#testing-requirements). Static checks alone do not replace tests for code changes.
4040

4141
**When to use:** Every contribution (documentation, code, infrastructure).
4242

docs/recipes/tier-0-dev/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "T0 — Dev: The Local Training Lifecycle Loop"
33
description: Run the full capture, curate, train, validate, and run loop on one laptop and one robot with zero cloud
44
author: Microsoft Robotics-AI Team
5-
ms.date: 2026-09-15
5+
ms.date: 2026-09-22
66
ms.topic: tutorial
77
---
88

@@ -36,7 +36,7 @@ Everything below runs on the single machine in front of you. The only thing that
3636
data you copy off the robot with `cp` or `rsync`.
3737

3838
The default instructions use plain processes. The optional
39-
[GPU Offload T0 plan](../../../gpu-offload/docs/05-T0-plan.md) permits a local kind
39+
[GPU Offload T0 plan](pathname://../../../gpu-offload/docs/05-T0-plan.md) permits a local kind
4040
cluster on the same laptop when process isolation, GPU allocation, or the Kubernetes
4141
offload controller is useful. T0 still excludes remote clusters and cloud dependencies.
4242

docs/reference/workflow-templates-azureml.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Workflow Templates (AzureML)
33
description: Selected AzureML workflow templates for RL, LeRobot, and SiL training and evaluation.
44
author: Microsoft Robotics-AI Team
5-
ms.date: 2026-09-21
5+
ms.date: 2026-09-22
66
ms.topic: reference
77
keywords:
88
- azureml
@@ -12,7 +12,7 @@ keywords:
1212
- evaluation
1313
---
1414

15-
Selected AzureML workflow templates for RL, LeRobot, and software-in-the-loop (SiL) training and evaluation, consistent with the [AzureML workflow index](../../workflows/azureml/README.md). This is not an exhaustive inventory and does not cover VLA workflows.
15+
Selected AzureML workflow templates for RL, LeRobot, and software-in-the-loop (SiL) training and evaluation, consistent with the [AzureML workflow index](pathname://../../workflows/azureml/README.md). This is not an exhaustive inventory and does not cover VLA workflows.
1616
Template names, defaults, and paths in this page are derived from the YAML files
1717
in `training/` and `evaluation/`.
1818

0 commit comments

Comments
 (0)