Skip to content

docs: update Quick start example to markdown prompt format - #278

Merged
pelikhan merged 2 commits into
mainfrom
copilot/update-readme-example
Jul 29, 2026
Merged

docs: update Quick start example to markdown prompt format#278
pelikhan merged 2 commits into
mainfrom
copilot/update-readme-example

Conversation

Copilot AI commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

The README Quick start showed a .ts file, but rig programs are typically authored as .md files with a nested ```rig ``` code block — the format used by all samples in skills/rig/samples/.

Changes

  • README.md: Replace the ts fenced block with a md outer fence containing a # Review Git Diff heading and an inner ```rig ``` block, matching the canonical sample format
  • Update the run command from program.tsprogram.md
# Review Git Diff

```rig
import { agent, p, s } from "rig";

const reviewDiff = agent({
  model: "small",
  instructions: p`Review ${p.bash("git diff -- .")} and return only the declared output.`,
  output: s.object({ summary: s.string, risk: s.enum("low", "medium", "high") }),
});

export default reviewDiff;
```

…ig code block

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title Update README Quick start example to markdown prompt format docs: update Quick start example to markdown prompt format Jul 29, 2026
Copilot AI requested a review from pelikhan July 29, 2026 09:12
@pelikhan
pelikhan marked this pull request as ready for review July 29, 2026 09:37
@pelikhan
pelikhan merged commit f9febf3 into main Jul 29, 2026
2 checks passed
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.

2 participants