Skip to content

Frame Guide Step 2 with CLI vs API roles and filter hints#295

Open
PunchTheDev wants to merge 1 commit into
mainfrom
punch/guide-step2-cli-api-frame
Open

Frame Guide Step 2 with CLI vs API roles and filter hints#295
PunchTheDev wants to merge 1 commit into
mainfrom
punch/guide-step2-cli-api-frame

Conversation

@PunchTheDev
Copy link
Copy Markdown
Owner

Summary

Step 2 (/guide#explore) previously dumped 7 CLI commands + 6 curl commands cold with a generic two-sentence intro. First-timer scans 13 commands, doesn't know which to run, bounces.

Changes

  • New lead at QuickstartGuide.tsx L492–500: distinguishes the two browsing routes — forge CLI for humans (terminal-friendly, fastest to scan) vs /specs HTTP endpoint for agents that fetch problem definitions programmatically. Names roles, not features.
  • New second paragraph at L501–507: concrete filter hints in plain language — --tier easy to warm up, --material to specialize, --unclaimed for problems with no Align dashboard types with forge-api response shapes #1 (first passing submission claims them, no margin required). Resolves the "which of these 7 commands matters for me?" anxiety.
  • Interstitial between CLI and curl blocks (L519): Or directly via the API:Same data over HTTP — what your agent reaches for once it runs unsupervised:. Tells you when you'd switch from CLI to API instead of just labeling the next block.
  • BACKLOG: split bundled Step 1–5 line into 5 individual lines so each can be graded separately. Step 2 marked ● ● ● with rationale + line range.

Verification

Puppeteer 1440×900 on /guide#explore:

  • 3 leads render exact: role frame, filter hints, HTTP interstitial
  • 5 inline <code> chips: forge, /specs, --tier easy, --material, --unclaimed
  • 2 code blocks preserved (CLI + curl)
  • Anchor lands at y=32 (matches scroll-mt-8)
  • 0 new console errors

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.

1 participant