Clarify the two supported Rig entry points in README - #282
Merged
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
Update README usage guidance
Clarify the two supported Rig entry points in README
Jul 29, 2026
Copilot created this pull request from a session on behalf of
pelikhan
July 29, 2026 11:51
View session
pelikhan
approved these changes
Jul 29, 2026
pelikhan
marked this pull request as ready for review
July 29, 2026 11:52
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README currently centers on a single quick-start path and local development commands, but does not clearly present the two primary ways Rig is intended to be used. This update reframes the doc around those entry points: using Rig as a skill in Copilot SDK workflows, and running Rig programs directly via
skills/rig/rig.ts.Usage model
Copilot SDK skill path
githubnext/rig/skills/rig/SKILL.md.copilotEngine().Direct launcher path
node skills/rig/rig.ts--typecheckpath so readers can validate programs without executing them.Doc focus
skills/rig/SKILL.mdandskills/rig/references/runtime.md.