Commit cb29b77
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 introduced1 parent 7ab7461 commit cb29b77
5 files changed
Lines changed: 11 additions & 11 deletions
File tree
- docs
- contributing
- recipes/tier-0-dev
- reference
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
| 6 | + | |
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| |||
114 | 114 | | |
115 | 115 | | |
116 | 116 | | |
117 | | - | |
| 117 | + | |
118 | 118 | | |
119 | 119 | | |
120 | 120 | | |
| |||
189 | 189 | | |
190 | 190 | | |
191 | 191 | | |
192 | | - | |
| 192 | + | |
193 | 193 | | |
194 | 194 | | |
195 | 195 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
| 6 | + | |
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| |||
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
35 | | - | |
| 35 | + | |
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
| 6 | + | |
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| |||
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
39 | | - | |
| 39 | + | |
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
39 | | - | |
| 39 | + | |
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | | - | |
| 15 | + | |
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
| |||
0 commit comments