Skip to content

docs: clarify when /fab-setup migrations is needed in upgrade section#449

Merged
sahil-noon merged 1 commit into
mainfrom
gritty-wombat
Jun 26, 2026
Merged

docs: clarify when /fab-setup migrations is needed in upgrade section#449
sahil-noon merged 1 commit into
mainfrom
gritty-wombat

Conversation

@sahil-noon

Copy link
Copy Markdown
Collaborator

Summary

The README's "Updating from a previous version" section listed /fab-setup migrations as an unconditional second step, which confused a user. In reality, fab upgrade-repo only requires that step when its output prints a highlighted Run '/fab-setup migrations'... line — and that step runs in your AI agent, not the terminal. This reframes step 2 as conditional and adds two screenshots illustrating the cue and the follow-up.

Changes

  • Added a sentence under step 1 explaining that fab upgrade-repo's output tells you whether step 2 is needed (the highlighted migration-prompt line); no line means you're up to date.
  • Marked step 2 as "(only if step 1 flagged a migration)".
  • Embedded two screenshots in docs/img/ (the terminal upgrade-repo output and Claude Code running /fab-setup migrations), following the repo's existing raw.githubusercontent.com/.../docs/img/ image convention.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@sahil-noon sahil-noon marked this pull request as ready for review June 26, 2026 07:27
@sahil-noon sahil-noon merged commit 22d5d55 into main Jun 26, 2026
3 checks passed
@sahil-noon sahil-noon deleted the gritty-wombat branch June 26, 2026 07:27
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