Skip to content

docs: add AI-friendly visualization guidance - #232

Closed
jfust3 wants to merge 1 commit into
harmoniqs:mainfrom
jfust3:docs/visualization-ai-guide
Closed

docs: add AI-friendly visualization guidance#232
jfust3 wants to merge 1 commit into
harmoniqs:mainfrom
jfust3:docs/visualization-ai-guide

Conversation

@jfust3

@jfust3 jfust3 commented Jun 4, 2026

Copy link
Copy Markdown

Summary

  • Adds llms.txt with AI-assistant guidance for Piccolo.jl visualization APIs
  • Adds a quick-reference section to the visualization guide for AI-generated plotting code
  • Documents common plotting helpers, required imports, and safe usage patterns
  • Adds guardrails for animation outputs and Makie extension usage

Test Plan

  • git diff --check origin/main...HEAD

Note: I did not run the Julia docs build in this environment because julia is not installed here.

Closes #61

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

@jack-champagne

jack-champagne commented Jun 15, 2026

Copy link
Copy Markdown
Member

Hey @jfust3, thanks for your contribution. I think that the CONTEXT.md file is the file that contains most of what you've already submitted, perhaps just make changes to that instead of adding an llms.txt. Re-open if you do see changes to be incorporated in the CONTEXT.md file there. Thanks!

@jfust3

jfust3 commented Jun 16, 2026

Copy link
Copy Markdown
Author

Thanks — I moved the AI visualization guidance into src/visualizations/CONTEXT.md and removed the top-level llms.txt, keeping the existing visualization guide doc changes. I tried to reopen the PR but GitHub would not reopen it from this side; happy to reopen if permissions allow or resubmit if you prefer.

@jfust3

jfust3 commented Jun 16, 2026

Copy link
Copy Markdown
Author

Since GitHub would not let me reopen this closed PR, I opened the CONTEXT.md-based update here: #243.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[unitaryDESIGN] Documentation Improvement for AI Agents

2 participants