Skip to content

Commit 78e526e

Browse files
docs: remove placeholders and coming soon mentions
- Remove screenshot and asciinema placeholder components - Replace "coming soon" with link to GitHub Discussions
1 parent 09c4cd4 commit 78e526e

3 files changed

Lines changed: 29 additions & 25 deletions

File tree

docs/guide/quick-start.md

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -48,58 +48,64 @@ chief --version
4848

4949
## Step 2: Create Your First PRD
5050

51-
Navigate to your project directory and initialize Chief:
51+
Navigate to your project directory and create a new PRD:
5252

5353
```bash
5454
cd your-project
5555
chief new
5656
```
5757

58-
<PlaceholderImage label="Screenshot: chief new flow" height="250px" />
58+
This launches Claude Code with a preloaded prompt. Work with Claude to describe what you want to build—your project goals, user stories, and acceptance criteria. Claude will help structure your requirements and write the `prd.md` file.
5959

60-
This creates a `.chief/` directory with a sample PRD to get you started. The PRD includes:
60+
When you're done, type `/exit` to leave Claude Code. Chief then parses `prd.md` and generates `prd.json`:
6161

62-
- `prd.md` - Human-readable project requirements
63-
- `prd.json` - Machine-readable user stories for Chief to execute
62+
- `prd.md` - Human-readable project requirements (written by Claude)
63+
- `prd.json` - Machine-readable user stories for Chief to execute (generated by Chief)
6464

65-
::: tip Customize your PRD
66-
Open `.chief/prds/default/prd.md` in your editor to write your own user stories. Chief will parse it into `prd.json` automatically.
65+
::: tip Iterating on your PRD
66+
Run `chief edit` to reopen Claude Code and refine your `prd.md`. Chief will regenerate `prd.json` when you `/exit`.
6767
:::
6868

69-
## Step 3: Run the Loop
69+
## Step 3: Launch the TUI
7070

71-
Start the autonomous loop:
71+
Launch Chief's Terminal User Interface:
7272

7373
```bash
7474
chief
7575
```
7676

77-
That's it! Chief takes over from here.
77+
This opens the TUI dashboard in **Ready** state. The loop doesn't start automatically—you control when it begins.
7878

79-
## Step 4: Watch It Work
79+
## Step 4: Start the Loop
8080

81-
Chief launches a beautiful TUI (Terminal User Interface) that shows:
81+
Press `s` to start the Ralph Loop. Chief will begin working through your stories automatically.
8282

83-
- **Current Story** - Which user story is being implemented
84-
- **Live Output** - Real-time streaming from Claude
85-
- **Progress** - How many stories are complete vs remaining
83+
The TUI shows:
8684

87-
<PlaceholderImage label="Screenshot: TUI Dashboard" height="400px" />
85+
- **Tab Bar** - All your PRDs with status indicators
86+
- **Stories List** - User stories with completion status
87+
- **Story Details** - Current story's description and acceptance criteria
88+
- **Live Activity** - Real-time status updates from Claude
8889

8990
### Keyboard Controls
9091

9192
| Key | Action |
9293
|-----|--------|
93-
| `Tab` | Switch between output and log views |
94-
| `↑/↓` | Scroll through output |
95-
| `q` | Quit Chief |
94+
| `s` | **Start** the loop (when Ready, Paused, or Stopped) |
95+
| `p` | **Pause** the loop (finishes current iteration) |
96+
| `x` | **Stop** the loop immediately |
97+
| `t` | **Toggle** between Dashboard and Log views |
98+
| `n` | Open **PRD picker** to switch or create PRDs |
99+
| `1-9` | **Quick switch** to PRD tabs 1-9 |
100+
| `j/↓` | Navigate down (stories or scroll log) |
101+
| `k/↑` | Navigate up (stories or scroll log) |
102+
| `?` | Show **help** overlay |
103+
| `q` | **Quit** Chief |
96104

97105
::: info Hands-off operation
98-
Chief runs autonomously. You can watch the progress or walk away - it will complete your PRD and play a sound when done.
106+
Once started with `s`, Chief runs autonomously. You can watch the progress or walk awayit will complete your PRD and play a sound when done.
99107
:::
100108

101-
<AsciinemaPlaceholder label="Recording: Full Chief Workflow (chief new → chief)" />
102-
103109
## What's Next?
104110

105111
Now that you've run your first Chief loop, explore these resources:

docs/reference/cli.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -254,8 +254,6 @@ When Chief is running, the TUI provides real-time feedback and interactive contr
254254
The TUI has two main views: **Dashboard** showing stories and progress, and **Log** view streaming Claude's output in real time. Press `t` to toggle between them.
255255
:::
256256

257-
<PlaceholderImage label="Screenshot: TUI Log View" height="400px" />
258-
259257
## Exit Codes
260258

261259
Chief uses standard exit codes:

docs/troubleshooting/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ For specific problems and solutions.
128128

129129
### Is there a community chat?
130130

131-
Coming soon. For now, use GitHub Discussions.
131+
Use [GitHub Discussions](https://github.com/minicodemonkey/chief/discussions) for questions and community support.
132132

133133
### Can I contribute?
134134

0 commit comments

Comments
 (0)