Skip to content

feat: add Claude Code plugin for InstUI docs lookup#2633

Open
balzss wants to merge 2 commits into
masterfrom
feat/instui-claude-plugin
Open

feat: add Claude Code plugin for InstUI docs lookup#2633
balzss wants to merge 2 commits into
masterfrom
feat/instui-claude-plugin

Conversation

@balzss

@balzss balzss commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add an instui Claude Code plugin (marketplace manifest at repo root + plugins/instui/) shipping an instui-docs skill that answers InstUI questions from instructure.design's plaintext docs (llms.txt index + per-page markdown) instead of guessing APIs.
  • Reference the plugin from the Getting Started guide's "Using InstUI with AI coding agents" section, with install commands.

Test Plan

  • Before merge: /plugin marketplace add instructure/instructure-ui resolves from the default branch, so the plugin isn't installable that way yet — install it locally to test (check out this branch, then /plugin marketplace add <local path>).
  • In a new/blank React project (e.g. npm create vite@latest) that consumes @instructure/ui, install the plugin from Claude Code with /plugin marketplace add instructure/instructure-ui then /plugin install instui@instructure-ui, and confirm asking an InstUI question (e.g. "which props does Modal take?") fetches the docs and answers with citations.
  • Verify the Getting Started page renders the new subsection correctly on the docs site.

Fixes INSTUI-5093

🤖 Generated with Claude Code

Add an "instui" Claude Code plugin, distributed via a marketplace manifest at the repo root,
that ships an "instui-docs" skill. The skill teaches Claude to answer InstUI questions from the
plaintext docs on instructure.design (llms.txt index + per-page markdown) instead of guessing
component APIs from memory.

Consumers install it with `/plugin marketplace add instructure/instructure-ui` and
`/plugin install instui@instructure-ui`. Reference the plugin from the Getting Started guide's
"Using InstUI with AI coding agents" section.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@balzss balzss self-assigned this Jul 8, 2026
@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://instructure.design/pr-preview/pr-2633/

Built to branch gh-pages at 2026-07-21 10:16 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown

Visual regression report

No changes.

Status Count
Unchanged 32
Changed 0
New 0
Removed 0

📊 View full report

Baselines come from the visual-baselines branch. They refresh on every merge to master.

github-actions Bot pushed a commit that referenced this pull request Jul 8, 2026
@balzss
balzss requested a review from matyasf July 8, 2026 13:52

@matyasf matyasf left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

See my comments. Also the how to test instructions did not work because this code is in a branch. I've installed the skill locally like:

Image

then used is to create an InstUI only TODO app, which went really well (see screenshot)

Image

Comment thread plugins/instui/skills/instui-docs/SKILL.md Outdated
Comment thread plugins/instui/skills/instui-docs/SKILL.md Outdated
@balzss

balzss commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

yeah, /plugin marketplace add only resolves once merged, so local install is the way to test beforehand. i'll note that in the test plan

Recommend the @instructure/ui metapackage for greenfield projects and
drop the misleading claim that the online docs are only better for prose
— the markdowns intentionally contain props tables, examples, and
guidelines. Keep the version-pinning caveat about node_modules types.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
github-actions Bot pushed a commit that referenced this pull request Jul 21, 2026
@balzss
balzss requested a review from matyasf July 21, 2026 10:41

@matyasf matyasf left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good. I have not tested how it will perform on an older version, we are not giving it any guidance

@balzss
balzss requested a review from joyenjoyer July 22, 2026 10:44

@joyenjoyer joyenjoyer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Great, it worked well for me; for questions that their answer that cannot be found on the docs site it looked into the npm package metadata and gave a correct answer.

@joyenjoyer

Copy link
Copy Markdown
Contributor

@balzss Check this PR, it might break something with this plugin

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.

3 participants