Skip to content

Add capability and Diataxis frontmatter to the SO-ARM101 workshop - #5393

Merged
Eliza Farley (elizafarley) merged 1 commit into
mainfrom
fix/so-arm101-workshop-frontmatter
Oct 6, 2026
Merged

Eliza Farley (elizafarley) merged 1 commit into
mainfrom
fix/so-arm101-workshop-frontmatter

Conversation

@elizafarley

Copy link
Copy Markdown
Contributor

Summary

The SO-ARM101 palletizing workshop (#5181) shipped seven published pages with no capabilities: or diataxis: frontmatter. check-capabilities.py and check-diataxis.py only warn, so CI passed. But the docs-health dashboard's daily build treats a page with no tag and no mode as a hard failure, and it has not been able to publish since Oct 3.

This PR tags the pages the same way the pick-and-place workshop is tagged:

Page diataxis capabilities
_index.md overview motion-planning, frame-system, hw-arm, hw-actuation, docs
01-platform-mental-model tutorial machine-config, motion-planning, frame-system, docs
02-configure-the-arm tutorial discovery, hw-arm, hw-actuation, frame-system, docs
03-teach-the-cell tutorial hw-arm, frame-system, docs
04-pack-from-python tutorial sdks, motion-planning, hw-actuation, docs
05-avoid-placed-cubes tutorial motion-planning, frame-system, docs
06-wrap-up tutorial motion-planning, frame-system, hw-arm, docs

It also adds the workshop's _phase-template.md (a headless draft) to the EXCLUDE set in both check scripts, next to the pick-and-place template. Without that, check-capabilities.py warns about the template.

Testing

  • python3 scripts/check-diataxis.py: all pages valid
  • python3 scripts/check-capabilities.py: all pages valid
  • Prettier: clean

Review process:

  • No need to request review from any specific docs team members; we will see your PR and one of us will review.
  • If you need technical review from engineering, please request review from the relevant person.
  • Docs team might commit styling nit fixes to save you the trouble :)
  • You can merge after approval from one docs team member (as well as any necessary technical review).

🤖 Generated with Claude Code

The seven published pages of the SO-ARM101 palletizing workshop (#5181)
shipped without capabilities: or diataxis: frontmatter. Tag them the way
the pick-and-place workshop is tagged: the landing page is an overview,
each phase is a tutorial, and every page carries docs plus the
capabilities that phase exercises.

Also exclude the workshop's _phase-template.md from both frontmatter
checks, alongside the pick-and-place template.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@netlify

netlify Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit dca416b
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6ac4fb04a6e17e0008273d22
😎 Deploy Preview https://deploy-preview-5393--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 37 (🟢 up 1 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Oct 6, 2026
@jeremyrose-viam

Copy link
Copy Markdown
Member

The diataxis and capability tags look good. I'd suggest changing the EXCLUDE approach, though.

The two _phase-template.md files (pick-and-place and so-arm101-palletizing) are nearly identical. They differ only in the workshop name, phase_total, the prev/next paths, and a couple of comment lines. Nothing else references them besides the EXCLUDE sets in these two scripts, so each new workshop would mean another entry in both.

Instead of extending the list, could we:

  1. Delete both _phase-template.md files.
  2. Add a single docs/tutorials/workshop-phase-template.md next to template.md, using placeholders (workshop: "your-workshop-slug", phase_total: N, generic prev/next) and keeping headless: true and draft: true.
  3. Set EXCLUDE to {template.md, workshop-phase-template.md} in both scripts, which then covers any future workshop.

Before merging, run make build-prod and confirm the new template doesn't show up in public/tutorials/, the sitemap, sitetree.json or llms.txt. template.md already sits in that directory, so I expect it to behave the same.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Up to you whether you think it's worth making the template change described above.

@elizafarley
Eliza Farley (elizafarley) merged commit 7544534 into main Oct 6, 2026
15 checks passed
@elizafarley
Eliza Farley (elizafarley) deleted the fix/so-arm101-workshop-frontmatter branch October 6, 2026 14:51
@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown

🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

safe to build This pull request is marked safe to build from a trusted zone

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants