Skip to content

Commit f92e7a3

Browse files
kongchen1992meta-codesync[bot]
authored andcommitted
{BugFix} Project Aria Plugins - Fix markdown lint errors in ARK plugin SKILL.md files
Summary: GitHub Actions `Markdown lint` job was failing with 11 errors across 6 SKILL.md files in `projectaria_ark_plugin/skills/`. All errors fall into three rules: - **MD040** (fenced code blocks missing language): 6 fenced blocks containing ASCII diagrams, filesystem trees, and math formulas. Marked them as `text` so the lint rule passes without forcing syntax highlighting that wouldn't help readers. - **MD012** (multiple consecutive blank lines): 1 stray double blank line in `aria-knowledge/SKILL.md` between the ALS section and the IMU noise model heading. - **MD032** (lists not surrounded by blank lines): 4 list-after-paragraph instances in `client-sdk`, `mps`, and `projectaria-tools` SKILL.md — added the required blank line between the lead-in line and the first bullet. No content changes — purely formatting to satisfy `markdownlint-cli2-action@v18` config in `.markdownlint.jsonc`. Files touched: - `projectaria_ark_plugin/skills/aria-knowledge/SKILL.md` (MD040 x2, MD012 x1) - `projectaria_ark_plugin/skills/client-sdk/SKILL.md` (MD032 x2) - `projectaria_ark_plugin/skills/client-sdk-ros2-integration/SKILL.md` (MD040 x1) - `projectaria_ark_plugin/skills/cloud-streaming/SKILL.md` (MD040 x3) - `projectaria_ark_plugin/skills/mps/SKILL.md` (MD032 x1) - `projectaria_ark_plugin/skills/projectaria-tools/SKILL.md` (MD032 x1) ___ Differential Revision: D109348371 fbshipit-source-id: dae9ad4d107368a62afcee0c82b691a81b754a01
1 parent bd107fd commit f92e7a3

6 files changed

Lines changed: 10 additions & 7 deletions

File tree

projectaria_ark_plugin/skills/aria-knowledge/SKILL.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This skill is the **knowledge index** for Project Aria Gen 2 and the Aria Resear
99

1010
## How to use this skill
1111

12-
```
12+
```text
1313
Question type → Action
1414
─────────────────────────────────────────────────────────────────────────
1515
What is X? / How does Y work? → Answer from this skill
@@ -105,7 +105,6 @@ Key behavior:
105105

106106
For channel peak wavelengths, sample rate, the full processing equations (normalize / flux / lux / CCT), factory calibration JSON layout, gain LUT, saturation rate, and PAT loading code: `/technical-specs/device/als`.
107107

108-
109108
### IMU noise model
110109

111110
Aria's stochastic IMU error is modeled as three additive components:
@@ -221,7 +220,7 @@ CPF is the midpoint of the left and right nominal pupil frames. **It exists only
221220

222221
**Recommendation: don't use CPF.** Use a sensor-frame relative pose instead:
223222

224-
```
223+
```text
225224
T_sensor1_sensor2 = T_Device_sensor1.inverse() * T_Device_sensor2
226225
```
227226

projectaria_ark_plugin/skills/client-sdk-ros2-integration/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Any other package name fails with `ImportError`. The `aria_data_types` package c
4545

4646
## Workflow
4747

48-
```
48+
```text
4949
1. Extract SDK samples python3 -m aria.extract_sdk_samples --out ~/Downloads
5050
→ yields AriaRaw.msg, ros2_publisher_example.py,
5151
ros2_subscriber_example.py

projectaria_ark_plugin/skills/client-sdk/SKILL.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,11 +149,13 @@ The pip package includes both. Gen1 uses `aria` CLI and `import aria.sdk`. Gen2
149149
**When any Client SDK command fails or returns unexpected output, you MUST consult this section and the official troubleshooting page BEFORE attempting your own diagnosis.** This is not optional. Aria failures have Aria-specific root causes (sandbox blocks, cert mismatches, thermal shutdowns, mDNS issues) that generic debugging will misdiagnose.
150150

151151
Anti-patterns:
152+
152153
- ❌ "I think I know what's wrong" — check the table first; your guess wastes the user's time when the documented fix is one row away.
153154
- ❌ "Let me try a different approach" — the documented fix exists for a reason. Try it before improvising.
154155
- ❌ "This looks like a generic Python/network error" — it almost certainly has an Aria-specific cause.
155156

156157
**Resources**:
158+
157159
- **First step always**: `aria_doctor` — configures ports and diagnoses connectivity.
158160
- **Official troubleshooting page**: https://facebookresearch.github.io/projectaria_tools/gen2/ark/support/sdk — covers symptoms not listed below.
159161

projectaria_ark_plugin/skills/cloud-streaming/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ If your collection point is on the **same WiFi** as the glasses, plain local str
2121

2222
## Architecture
2323

24-
```
24+
```text
2525
Aria Glasses ──(WiFi → internet)──► Your HTTPS Server :6768
2626
HTTPS POST (decode / store / forward)
2727
```
@@ -40,7 +40,7 @@ The glasses open an HTTPS connection to a URL you provide and POST sensor data c
4040

4141
The certificates were generated when the SDK was first set up. They live on the PC where the SDK was installed at:
4242

43-
```
43+
```text
4444
~/.aria/streaming-certs/persistent/
4545
├── subscriber.pem # server cert (PEM)
4646
├── subscriber-key.pem # server private key
@@ -103,7 +103,7 @@ Without batching, the device will hit its thermal shutdown threshold (~44 °C)
103103

104104
**Workaround**: deploy a **public relay** — a small VM with a public IP that the glasses POST to — and forward via SSH / WireGuard tunnel into your internal server:
105105

106-
```
106+
```text
107107
Aria Glasses ──► Public Relay (VM, public IP) ─tunnel─► Your Internal Server
108108
HTTPS POST :6768 SSH / (behind VPN)
109109
WireGuard

projectaria_ark_plugin/skills/mps/SKILL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ On-device eye gaze and VIO are embedded in the VRS during recording (accessible
8181
**When any MPS command fails, returns unexpected output, or produces low-quality results, you MUST consult this section and the official troubleshooting page BEFORE attempting your own diagnosis.** This is not optional. MPS failures have MPS-specific root causes (health check rejections, insufficient recording length, coordinate frame mismatches) that generic debugging will misdiagnose.
8282

8383
Anti-patterns:
84+
8485
- ❌ "I think I know what's wrong" — check the list below and the official page first; your guess wastes the user's time when the documented fix is right here.
8586
- ❌ "Let me try reprocessing" — understand WHY it failed first. Blindly rerunning with `--force` wastes upload time and quota.
8687
- ❌ "This looks like a generic upload/network error" — MPS has specific retry and resumable upload logic. Check the CLI guide before improvising.

projectaria_ark_plugin/skills/projectaria-tools/SKILL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,7 @@ Source: https://github.com/facebookresearch/projectaria_tools/tree/main/projecta
242242
Exports **on-device** machine-perception streams (VIO, eye gaze, hand tracking, online calibration) from a Gen 2 VRS into CSV / JSONL files in the **same format as cloud MPS outputs**.
243243

244244
**Use when**:
245+
245246
- You want to compare on-device perception against cloud MPS on the same recording.
246247
- You want to reuse MPS-loading code on a recording you haven't sent through MPS.
247248

0 commit comments

Comments
 (0)