Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions .github/workflows/docusaurus-tests.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
name: Docusaurus Tests

on:
pull_request:
paths:
- 'docs/docusaurus/**'
- '.github/workflows/docusaurus-tests.yml'
workflow_call:
inputs:
soft-fail:
Expand Down
9 changes: 9 additions & 0 deletions .github/workflows/pr-validation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,15 @@ jobs:
contents: read
id-token: write

# Docusaurus documentation site tests and build verification
docusaurus-tests:
name: Docusaurus Tests
uses: ./.github/workflows/docusaurus-tests.yml
with:
soft-fail: false
permissions:
contents: read

# Python pytest test execution
pytest-tests:
name: Pytest Tests
Expand Down
2 changes: 0 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,6 @@ Standalone guides available now. These cover common tasks and will move into the

| Guide | Description |
|------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|
| [AzureML Validation Job Debugging](operations/azureml-validation-job-debugging.md) | Diagnosing and resolving AzureML validation job failures on AKS, including pod scheduling and resource quota issues |
| [LeRobot Inference](inference/lerobot-inference.md) | Running LeRobot inference workloads with pre-trained policies on Azure infrastructure |
| [MLflow Integration](training/mlflow-integration.md) | Configuring MLflow experiment tracking for SKRL training agents with automatic metric logging to Azure ML |
| [Security Guide](operations/security-guide.md) | Security configuration inventory, deployment responsibilities, and hardening checklist for robotics workloads |

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Search existing resources before asking questions:
* Search [GitHub Issues](https://github.com/microsoft/physical-ai-toolchain/issues) for similar questions or problems
* Check [GitHub Discussions](https://github.com/microsoft/physical-ai-toolchain/discussions) for community Q&A
* Review [docs/](https://github.com/microsoft/physical-ai-toolchain/tree/main/docs) for troubleshooting guides
* See [azureml-validation-job-debugging.md](../operations/azureml-validation-job-debugging.md) for common deployment and workflow issues
* See azureml-validation-job-debugging.md for common deployment and workflow issues
Comment thread
WilliamBerryiii marked this conversation as resolved.
Outdated

If you cannot find an answer:

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/contribution-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ Documentation contributions improve the architecture for the entire robotics and

### High-Value Documentation Contributions

* Deployment troubleshooting guides: Expand [azureml-validation-job-debugging.md](../operations/azureml-validation-job-debugging.md) with new scenarios
* Deployment troubleshooting guides: Expand azureml-validation-job-debugging.md with new scenarios
Comment thread
WilliamBerryiii marked this conversation as resolved.
Outdated
* Region/SKU compatibility matrices: Document tested combinations and known limitations
* Cost optimization strategies: Real-world cost profiles and reduction techniques
* Network architecture decisions: Guidance on when to use private vs. hybrid vs. public modes
Expand Down
1 change: 0 additions & 1 deletion docs/data-pipeline/chunking-compression-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,6 @@ Post-processing or LeRobot conversion fails with codec errors (`zstd: error` in

## Related Documentation

- [LeRobot Inference](../inference/lerobot-inference.md) for policy deployment after training on recorded data
- [Security Guide](../operations/security-guide.md) for data encryption of recorded bags at rest

## Sources
Expand Down
7 changes: 4 additions & 3 deletions docs/docusaurus/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,13 @@ const config = {
organizationName: 'microsoft',
projectName: 'physical-ai-toolchain',

onBrokenLinks: 'warn',
onBrokenLinks: 'throw',
onDuplicateRoutes: 'throw',

markdown: {
format: 'detect',
hooks: {
onBrokenMarkdownLinks: 'warn',
onBrokenMarkdownLinks: 'throw',
},
},

Expand Down Expand Up @@ -94,7 +95,7 @@ const config = {
},
{
label: 'Deploy',
to: '/deploy/',
to: '/infrastructure/',
},
{
label: 'Training',
Expand Down
8 changes: 4 additions & 4 deletions docs/docusaurus/src/data/hubCards.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export const iconCards: IconCardProps[] = [
icon: <CloudIcon />,
supertitle: 'Infrastructure',
title: 'Deploy Infrastructure',
href: '/deploy/',
href: '/infrastructure/',
description: 'Provision AKS clusters, networking, storage, and identity with Terraform.',
},
{
Expand Down Expand Up @@ -56,7 +56,7 @@ export const boxCards: BoxCardProps[] = [
title: 'Architecture Guide',
links: [
{ label: 'System architecture', href: '/contributing/architecture' },
{ label: 'Network topology', href: '/deploy/infrastructure-reference' },
{ label: 'Network topology', href: '/infrastructure/infrastructure-reference' },
{ label: 'Lifecycle domains', href: '/contributing/architecture#domain-overview' },
],
icon: '/img/icons/clipboard-task.svg',
Expand All @@ -74,8 +74,8 @@ export const boxCards: BoxCardProps[] = [
title: 'Security',
links: [
{ label: 'Security review checklist', href: '/contributing/security-review' },
{ label: 'Private cluster access', href: '/deploy/vpn' },
{ label: 'Identity and credentials', href: '/deploy/infrastructure#osmo-workload-identity' },
{ label: 'Private cluster access', href: '/infrastructure/vpn' },
{ label: 'Identity and credentials', href: '/infrastructure/infrastructure-deployment#osmo-workload-identity' },
],
icon: '/img/icons/shield-lock.svg',
},
Expand Down
Empty file.
4 changes: 2 additions & 2 deletions docs/fleet-deployment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ Deploy trained robot policies to edge fleets via FluxCD GitOps pipelines, image

## Topics

- [GitOps architecture](../../fleet-deployment/specifications/gitops.specification.md)
- [Deployment gating](../../fleet-deployment/specifications/gating-service.specification.md)
- [GitOps architecture](https://github.com/microsoft/physical-ai-toolchain/blob/main/fleet-deployment/specifications/gitops.specification.md)
- [Deployment gating](https://github.com/microsoft/physical-ai-toolchain/blob/main/fleet-deployment/specifications/gating-service.specification.md)
8 changes: 4 additions & 4 deletions docs/fleet-intelligence/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Fleet-wide telemetry collection, operational dashboards, drift detection, and au

| Guide | Description |
|-----------------------------------------------------------------------------------------------------------|---------------------------------------|
| [Telemetry Specification](../../fleet-intelligence/specifications/telemetry.specification.md) | Schema and routing architecture |
| [Dashboard Specification](../../fleet-intelligence/specifications/dashboards.specification.md) | Fleet dashboard and alerting design |
| [Drift Detection Specification](../../fleet-intelligence/specifications/drift-detection.specification.md) | Detection algorithms and thresholds |
| [Retraining Specification](../../fleet-intelligence/specifications/retraining.specification.md) | Automated retraining trigger pipeline |
| [Telemetry Specification](https://github.com/microsoft/physical-ai-toolchain/blob/main/fleet-intelligence/specifications/telemetry.specification.md) | Schema and routing architecture |
| [Dashboard Specification](https://github.com/microsoft/physical-ai-toolchain/blob/main/fleet-intelligence/specifications/dashboards.specification.md) | Fleet dashboard and alerting design |
| [Drift Detection Specification](https://github.com/microsoft/physical-ai-toolchain/blob/main/fleet-intelligence/specifications/drift-detection.specification.md) | Detection algorithms and thresholds |
| [Retraining Specification](https://github.com/microsoft/physical-ai-toolchain/blob/main/fleet-intelligence/specifications/retraining.specification.md) | Automated retraining trigger pipeline |
1 change: 0 additions & 1 deletion docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,6 @@ See [Cost Considerations](../contributing/cost-considerations.md) for detailed p

| Resource | Description |
|---------------------------------------------------------------------------------------------------|-------------------------------------------|
| [LeRobot Inference](../inference/lerobot-inference.md) | Run inference with trained LeRobot models |
| [MLflow Integration](../training/mlflow-integration.md) | Track experiments with MLflow |
| [Deployment Guide](https://github.com/microsoft/physical-ai-toolchain/blob/main/deploy/README.md) | Full deployment reference and options |
| [Contributing Guide](../contributing/README.md) | Development workflow and code standards |
6 changes: 1 addition & 5 deletions docs/infrastructure/_category_.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
{
"label": "Infrastructure",
"position": 2,
"link": {
"type": "generated-index",
"description": "Deploy infrastructure and platform components."
}
"position": 2
}
1 change: 1 addition & 0 deletions docs/infrastructure/infrastructure.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 3
title: Infrastructure Deployment
slug: infrastructure-deployment
description: Terraform configuration and deployment for AKS, Azure ML, storage, and OSMO backend services
author: Microsoft Robotics-AI Team
ms.date: 2026-03-02
Expand Down
1 change: 0 additions & 1 deletion docs/operations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ Centralized hub for operational documentation covering monitoring, troubleshooti
| [Troubleshooting](troubleshooting.md) | Symptom-based resolution for common deployment, GPU, and workflow errors |
| [Security Guide](security-guide.md) | Security configuration inventory and deployment checklist |
| [GPU Configuration](../reference/gpu-configuration.md) | Driver selection, MIG strategy, and GPU Operator configuration |
| [AzureML Validation Job Debugging](./azureml-validation-job-debugging.md) | Debug AzureML extension and InstanceType validation failures |
| [Deployment Validation](../contributing/deployment-validation.md) | Post-deployment verification steps |
| [Cost Considerations](../contributing/cost-considerations.md) | Azure resource cost guidance |

Expand Down
1 change: 0 additions & 1 deletion docs/operations/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,6 @@ Convert all template expressions to Jinja syntax. For variable substitution, use
## Additional Resources

- [GPU Configuration](../reference/gpu-configuration.md)
- [AzureML Validation Job Debugging](./azureml-validation-job-debugging.md)
- [Security Guide](security-guide.md)
- [Deployment Validation](../contributing/deployment-validation.md)
- [NVIDIA CUDA Compatibility](https://docs.nvidia.com/deploy/cuda-compatibility/)
Expand Down
1 change: 0 additions & 1 deletion docs/reference/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ Technical reference documentation for submission scripts, workflow templates, en
## 📚 Related Documentation

* [Training Guide](../training/README.md) for RL and behavioral cloning workflows
* [Inference Guide](../inference/README.md) for running trained policies
* [Deployment Guide](https://github.com/microsoft/physical-ai-toolchain/blob/main/deploy/README.md) for infrastructure provisioning

<!-- markdownlint-disable MD036 -->
Expand Down
1 change: 0 additions & 1 deletion docs/training/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ LeRobot behavioral cloning on OSMO:
## 📚 Related Documentation

- [Deployment Guide](https://github.com/microsoft/physical-ai-toolchain/blob/main/deploy/README.md) for infrastructure setup
- [LeRobot Inference](../inference/lerobot-inference.md) for running trained policies
- [AzureML Workflows](https://github.com/microsoft/physical-ai-toolchain/blob/main/workflows/azureml/README.md) for job template reference
- [OSMO Workflows](https://github.com/microsoft/physical-ai-toolchain/blob/main/workflows/osmo/README.md) for workflow template reference
- [Scripts Reference](../reference/scripts.md) for CLI usage
Expand Down
1 change: 0 additions & 1 deletion docs/training/lerobot-training.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,6 @@ The `run-lerobot-pipeline.sh` script orchestrates the full lifecycle on OSMO:

## 🔗 Related Documentation

- [LeRobot Inference](../inference/lerobot-inference.md) for evaluating trained policies
- [Experiment Tracking](experiment-tracking.md) for MLflow and WANDB configuration
- [AzureML Workflows](https://github.com/microsoft/physical-ai-toolchain/blob/main/workflows/azureml/README.md) for job template reference
- [OSMO Workflows](https://github.com/microsoft/physical-ai-toolchain/blob/main/workflows/osmo/README.md) for workflow template reference
Expand Down
1 change: 0 additions & 1 deletion docs/training/mlflow-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,6 @@ Log messages like `"Failed to extract or log metrics at step X"` indicate transi
## Related Documentation

* [Training Guide](README.md)
* [Inference Guide](../inference/README.md)
* [Workflow Templates](https://github.com/microsoft/physical-ai-toolchain/blob/main/workflows/README.md)

---
Expand Down
Loading