Skip to content

Document sitetree.json's node schema inline in llms.txt - #5320

Merged
Jeremy Rose (jeremyrose-viam) merged 1 commit into
viamrobotics:mainfrom
jeremyrose-viam:worktree-llms-txt-schema-hint
Sep 17, 2026
Merged

Jeremy Rose (jeremyrose-viam) merged 1 commit into
viamrobotics:mainfrom
jeremyrose-viam:worktree-llms-txt-schema-hint

Conversation

@jeremyrose-viam

Copy link
Copy Markdown
Member

Summary

  • Adds a one-sentence schema hint to the sitetree.json link in /llms.txt: each node's title, the path/redirect distinction (real content vs. a signpost to skip), optional description, and the recursive children shape.
  • Prompted by reviewing a third-party "agent readiness" report against docs.viam.com — most of its findings didn't hold up under inspection, but this was a genuine cheap win: an agent currently has to fetch and reverse-engineer sitetree.json's shape before it can use it.

Test plan

  • hugo --minify -e production build succeeds with no errors/warnings
  • Rendered llms.txt output inspected directly; new sentence appears correctly on the sitetree.json bullet, rest of the file unchanged

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@netlify

netlify Bot commented Sep 15, 2026

Copy link
Copy Markdown

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit c01acf0
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6aa9c16f5196d40007c0180f
😎 Deploy Preview https://deploy-preview-5320--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: 41 (🟢 up 6 from production)
Accessibility: 99 (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 Sep 15, 2026
@jeremyrose-viam
Jeremy Rose (jeremyrose-viam) merged commit 336fe0d into viamrobotics:main Sep 17, 2026
13 checks passed
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