Frame Guide Step 1 by canonical Docker vs Native paths#296
Open
PunchTheDev wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Step 1 — Set up was muddled: "Docker is the easiest path" in the lead, but the code block showed
pip install -e .(CLI only, no FEA stack), and Docker was relegated to a footnote. First-timers couldn't tell which path they were on.This aligns the Guide vocabulary with
forge check-deps(forge/cli.pyL1136–1190), which already exposes the canonical two-paths model:Option A — Docker (recommended)vsOption B — Native toolchain. Lead names both paths inline, the CLI flow stays one code block, andforge check-depsis framed as the diagnostic that confirms which path is ready.Changes
QuickstartGuide.tsxL467–501: Step 1 lead rewritten to surface both paths verbatim fromcheck-deps; existing CalculiX/gmsh/OCP tooltips preserved.# Verify your setup→# Confirms which path is ready — Docker, Native, or both.forge eval --dockerfor first-timers with a new tooltip on--dockernaming theforge-evalCI image (so the local↔leaderboard parity is explicit).BACKLOG.md: bundled "Step 1–5" row split into 5 individual rows (matches the split started in Frame Guide Step 2 with CLI vs API roles and filter hints #295); Step 1 flipped○ ○ ○ → ● ● ●with the rationale.Test plan
npm run buildclean/guide#setup: lead contains both Option A and Option B strings; 4 tooltips (CalculiX 78 / gmsh 91 / OCP 107 / --docker 147 chars); code block containsforge check-deps+Docker, Native, or bothcomment; first-timer footnote present; 0 new console errors.