Skip to content

Commit 606f0f7

Browse files
fix(docs): resolve markdown lint and link errors
- auto-fix blanks-around-lists and blanks-around-fences violations - add LICENSE.md and ISSUE_TEMPLATE.md to lint ignores - fix line length and emphasis-as-heading in README - update Azure CLI URL to learn.microsoft.com 📝 - Generated by Copilot
1 parent d68294e commit 606f0f7

File tree

6 files changed

+29
-18
lines changed

6 files changed

+29
-18
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
<!--
22
IF SUFFICIENT INFORMATION IS NOT PROVIDED VIA THE FOLLOWING TEMPLATE THE ISSUE MIGHT BE CLOSED WITHOUT FURTHER CONSIDERATION OR INVESTIGATION
33
-->
4-
> Please provide us with the following information:
4+
> Please provide us with the following information
55
> ---------------------------------------------------------------
66
77
### This issue is for a: (mark with an `x`)
8+
89
```
910
- [ ] bug report -> please search issues before submitting
1011
- [ ] feature request
@@ -22,6 +23,7 @@ IF SUFFICIENT INFORMATION IS NOT PROVIDED VIA THE FOLLOWING TEMPLATE THE ISSUE M
2223
>
2324
2425
### OS and Version?
26+
>
2527
> Windows 7, 8 or 10. Linux (which distribution). macOS (Yosemite? El Capitan? Sierra?)
2628
2729
### Versions

.github/copilot-instructions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,24 @@ Items in **HIGHEST PRIORITY** sections from attached instructions files override
1313
**Artifacts:** Do not create or modify tests, scripts, or one-off markdown docs unless explicitly requested.
1414

1515
**Comment policy:** Never include thought processes, step-by-step reasoning, or narrative comments in code.
16+
1617
* Keep comments brief and factual; describe **behavior/intent, invariants, edge cases**.
1718
* Remove or update comments that contradict the current behavior. Do not restate obvious functionality.
1819
* Do NOT add temporal or plan-phase markers (e.g. "Phase 1 cleanup", "... after migration", dates, or task references) to code files. When editing or updating any code files, always remove or replace these types of comments.
1920

2021
**Conventions and Styling:** Always follow conventions and styling in this codebase FIRST for all changes, edits, updates, and new files.
22+
2123
* Conventions and styling are in instruction files and must be read in with the `read_file` tool if not already added as an `<attachment>`.
2224

2325
**Proactive fixes:** Always fix problems and errors you encounter, even if unrelated to the original request. Prefer root-cause, constructive fixes over symptom-only patches.
26+
2427
* Always correct all incorrect or problematic conventions, styling, and redundant and/or misleading comments.
2528

2629
**Deleting files and folders:** Use `rm` with the run_in_terminal tool when needing to delete files or folders.
2730

2831
**Edit tools:** Never use `insert_edit_into_file` tool when other edit and file modification tools are available.
2932

3033
**Memory and tracking work**: Always track work in Beads instead of Markdown.
34+
3135
* All upcoming work, tracked work, issues, plans, todos, phases, tasks, and memory must always use the mcp_beads tools.
3236
* Don't ever use git commands for anything related to the mcp_beads tools and beads in general, its at the user's discretion when to use git commands and tools.

.github/instructions/commit-message.instructions.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ Scopes MUST be one of the following:
3838
- `(src)`
3939
- `(deploy)`
4040

41-
4241
## Description
4342

4443
- Description MUST be short and LESS THAN 100 bytes
@@ -62,7 +61,7 @@ For larger changes only:
6261

6362
- Footer MUST start with a blank line
6463
- Must include an emoji that represents the change
65-
- Must end with ` - Generated by Copilot`
64+
- Must end with `- Generated by Copilot`
6665

6766
## Example Complete Commit Message - Large
6867

.markdownlint-cli2.jsonc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
"ignores": [
33
"**/node_modules/**",
44
".copilot-tracking/**",
5-
"venv/**"
5+
"venv/**",
6+
"LICENSE.md",
7+
".github/ISSUE_TEMPLATE.md"
68
],
79
"config": {
810
"default": true,

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE
21+
SOFTWARE

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# 🤖 Azure Robotics Reference Architecture with NVIDIA OSMO
22

3-
This reference architecture provides a production-ready framework for orchestrating robotics and AI workloads on [Microsoft Azure](https://azure.microsoft.com/) using NVIDIA technologies such as [Isaac Lab](https://developer.nvidia.com/isaac/lab), [Isaac Sim](https://developer.nvidia.com/isaac/sim), and [OSMO](https://developer.nvidia.com/osmo). It demonstrates end-to-end reinforcement learning workflows, scalable training pipelines, and deployment processes with Azure-native authentication, storage, and ML services.
3+
This reference architecture provides a production-ready framework for orchestrating robotics and AI workloads on [Microsoft Azure](https://azure.microsoft.com/) using NVIDIA technologies such as [Isaac Lab](https://developer.nvidia.com/isaac/lab), [Isaac Sim](https://developer.nvidia.com/isaac/sim), and [OSMO](https://developer.nvidia.com/osmo).
4+
It demonstrates end-to-end reinforcement learning workflows, scalable training pipelines, and deployment processes with Azure-native authentication, storage, and ML services.
45

56
## 🚀 Key Features
67

@@ -10,10 +11,10 @@ OSMO handles workflow orchestration and job scheduling while Azure provides elas
1011
- **Containerized Workflows** - Docker-based Isaac Lab training with NVIDIA GPU support
1112
- **CI/CD Integration** - Automated deployment pipelines with GitHub Actions
1213
- **MLflow Integration** - Automatic experiment tracking and model versioning
13-
- Automatic metric logging from SKRL agents to Azure ML
14-
- Comprehensive tracking of episode statistics, losses, optimization metrics, and timing data
15-
- Configurable logging intervals and metric filtering
16-
- See [MLflow Integration Guide](docs/mlflow-integration.md) for details
14+
- Automatic metric logging from SKRL agents to Azure ML
15+
- Comprehensive tracking of episode statistics, losses, optimization metrics, and timing data
16+
- Configurable logging intervals and metric filtering
17+
- See [MLflow Integration Guide](docs/mlflow-integration.md) for details
1718
- **Scalable Compute** - Auto-scaling GPU nodes based on workload demands
1819
- **Cost Optimization** - Pay-per-use compute with automatic scaling
1920
- **Enterprise Security** - Entra ID integration
@@ -22,6 +23,7 @@ OSMO handles workflow orchestration and job scheduling while Azure provides elas
2223
## 🗼 Architecture Overview
2324

2425
This reference architecture integrates:
26+
2527
- **NVIDIA OSMO** - Workflow orchestration and job scheduling
2628
- **Azure Machine Learning** - Experiment tracking and model management
2729
- **Azure Kubernetes Service** - Software in the Loop (SIL) training
@@ -30,7 +32,7 @@ This reference architecture integrates:
3032
- **Azure Key Vault** - Secure credential management
3133
- **Azure Monitor** - Comprehensive logging and metrics
3234

33-
**INSERT ARCHITECTURE DIAGRAM HERE**
35+
<!-- INSERT ARCHITECTURE DIAGRAM HERE -->
3436

3537
## 🌍 Real World Examples
3638

@@ -49,17 +51,19 @@ See [OSMO workflow examples](deploy/004-workflow/osmo/) for job configuration te
4951

5052
- [pyenv](https://github.com/pyenv/pyenv)
5153
- Python 3.11 (required by Isaac Sim 5.X)
52-
- [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli) (v2.50+)
54+
- [Azure CLI](https://learn.microsoft.com/cli/azure/install-azure-cli) (v2.50+)
5355
- [Terraform](https://www.terraform.io/downloads) (v1.5+)
5456
- [NVIDIA OSMO CLI](https://developer.nvidia.com/osmo) (latest)
5557
- [Docker](https://docs.docker.com/get-docker/) with NVIDIA Container Toolkit
5658

5759
### Azure Requirements
60+
5861
- Azure subscription with contributor access
5962
- Sufficient quota for GPU VMs (Standard_NC6s_v3 or higher)
6063
- Azure Machine Learning workspace (or permissions to create one)
6164

6265
### NVIDIA Requirements
66+
6367
- NVIDIA Developer account with OSMO access
6468
- NGC API key for container registry access
6569

@@ -112,14 +116,14 @@ This project is licensed under the MIT License. See [LICENSE.md](LICENSE.md) for
112116

113117
For issues and questions:
114118

115-
* Review [microsoft/edge-ai](https://github.com/microsoft/edge-ai) documentation
119+
- Review [microsoft/edge-ai](https://github.com/microsoft/edge-ai) documentation
116120

117121
## 🙏 Acknowledgments
118122

119123
This reference architecture builds upon:
120124

121-
* [microsoft/edge-ai](https://github.com/microsoft/edge-ai) - Edge AI infrastructure components
122-
* [NVIDIA Isaac Lab](https://github.com/isaac-sim/IsaacLab) - RL task framework
123-
* [NVIDIA Isaac Sim](https://developer.nvidia.com/isaac-sim) - Physics simulation
124-
* [NVIDIA OSMO](https://developer.nvidia.com/osmo) - Workflow orchestration
125-
* [NVIDIA OSMO GitHub](https://github.com/NVIDIA/OSMO) - Workflow orchestration
125+
- [microsoft/edge-ai](https://github.com/microsoft/edge-ai) - Edge AI infrastructure components
126+
- [NVIDIA Isaac Lab](https://github.com/isaac-sim/IsaacLab) - RL task framework
127+
- [NVIDIA Isaac Sim](https://developer.nvidia.com/isaac-sim) - Physics simulation
128+
- [NVIDIA OSMO](https://developer.nvidia.com/osmo) - Workflow orchestration
129+
- [NVIDIA OSMO GitHub](https://github.com/NVIDIA/OSMO) - Workflow orchestration

0 commit comments

Comments
 (0)