Skip to content

docs: GUI walkthrough installs from the lineforge repo - #44

Merged
RFingAdam merged 1 commit into
mainfrom
docs/fix-gui-walkthrough-url
Oct 16, 2026
Merged

RFingAdam merged 1 commit into
mainfrom
docs/fix-gui-walkthrough-url

Conversation

@RFingAdam

Copy link
Copy Markdown
Owner

examples/08_gui_walkthrough.md told readers to git clone https://github.com/RFingAdam/lineforge-gui and set up a separate backend venv and frontend there. That repo does not exist (the GUI was merged into lineforge itself, under frontend/ and src/lineforge/web/), so the instructions fail today and would fetch whatever code someone later puts at that name.

Changes:

  • Intro: the GUI ships inside the lineforge repo (lineforge.web backend, frontend/ Next.js app).
  • Prerequisites: clone RFingAdam/lineforge and pip install -e ".[gui]" (with the Rust toolchain note from the README), plus Node and pnpm on PATH. The separate backend venv and manual pnpm install steps are gone because lineforge gui handles the frontend deps.
  • Launch steps: match what lineforge gui in src/lineforge/cli.py does now (checks frontend/, installs node_modules if missing, runs uvicorn lineforge.web.app:app and pnpm dev, moves to a free port if busy).
  • The walkthrough, stopping and no-chat sections are unchanged.

Checked:

  • Re-grepped the repo for lineforge-gui: the only hit left is the private npm package name lineforge-gui-frontend in frontend/package.json, which is not a URL.
  • Steps checked against the gui command in src/lineforge/cli.py, the gui extra in pyproject.toml, and the dev/start scripts in frontend/package.json. Tool names in the walkthrough (set_geometry_type, set_geometry_field, target_z0) still exist in src/lineforge/web/agent.py.
  • Only examples/08_gui_walkthrough.md is touched.

The walkthrough told people to clone RFingAdam/lineforge-gui, which does
not exist (the GUI was merged into lineforge under frontend/ and
src/lineforge/web/), so anyone who registers that name could serve code to
readers. Describe the current setup: pip install -e ".[gui]" and lineforge gui.
@RFingAdam
RFingAdam merged commit c48b20c into main Oct 16, 2026
1 check failed
@RFingAdam
RFingAdam deleted the docs/fix-gui-walkthrough-url branch October 16, 2026 15:30
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