Skip to content

Guide first-run onboarding with numbered step copy #321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TheGreatAxios merged 3 commits into from
Aug 5, 2026
Merged

Guide first-run onboarding with numbered step copy #321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
72ea7db
Guide first-run onboarding with numbered step copy
TheGreatAxios Aug 5, 2026
8891069
Tighten onboarding guidance and fix post-setup shortcuts
TheGreatAxios Aug 5, 2026
a9ba3e4
Align onboarding name examples and cover step copy
TheGreatAxios Aug 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions src/tui/onboarding.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ const FIELD_LABELS: Record<Field, string> = {
};

const FIELD_HINTS: Record<Field, string> = {
name: "openai, anthropic, fireworks, ...",
name: "openai, anthropic, ollama, ...",
baseURL: "https://api.openai.com/v1",
apiKey: "sk-... (blank for keyless/local)",
model: "gpt-4o",
Expand Down Expand Up @@ -181,9 +181,20 @@ export function ProviderSetupPanel({ onSubmit, showTelemetryNotice }: ProviderSe

{/* Main content */}
<Box flexGrow={1} flexDirection="column" paddingX={4} paddingY={2}>
<Box marginBottom={2}>
<Text color={color("text")}>
No inference provider is configured. Add one to get started.
<Box marginBottom={1} flexDirection="column">
<Text color={color("text")} bold>
Welcome — connect an inference provider
</Text>
<Text color={color("muted")}>
Step {fieldIndex + 1} of {FIELDS.length}: {FIELD_LABELS[currentField]}
{" — "}
{currentField === "name" && "name it (openai, anthropic, ollama, …)"}
{currentField === "baseURL" && "paste the API base URL (include /v1 if required)"}
{currentField === "apiKey" && "API key (blank for local/keyless)"}
{currentField === "model" && "default model, then Enter to test & save"}
</Text>
<Text color={color("dim")}>
After setup, switch providers with /model
</Text>
</Box>

Expand Down
9 changes: 9 additions & 0 deletions tests/unit/tui/onboarding.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,15 @@ test("shows Provider name label on mount", () => {
expect(lastFrame()).toContain("Provider name");
});

test("shows welcome and step copy on mount", () => {
const { lastFrame } = renderPanel();
const frame = lastFrame() ?? "";
// Fixed-height panel (rows fallback 24) can flex-shrink the bold welcome
// line under ink-testing-library; assert the step banner that always shows.
expect(frame).toContain("Provider setup");
expect(frame).toContain("Step 1 of 4");
});

test("shows all field labels", () => {
const { lastFrame } = renderPanel();
expect(lastFrame()).toContain("Provider name");
Expand Down
Loading