Skip to content

docs: explain mechanical-only projects - #221

Closed
LighthouseRobotics wants to merge 1231 commits into
BackplaneWorks:mainfrom
LighthouseRobotics:docs/mechanical-quickstart
Closed

LighthouseRobotics wants to merge 1231 commits into
BackplaneWorks:mainfrom
LighthouseRobotics:docs/mechanical-quickstart

Conversation

@LighthouseRobotics

Copy link
Copy Markdown
Contributor

The README currently makes a KiCad project and KiCad installation sound mandatory, although project creation accepts an ordinary folder and the Mech viewer supports standalone models.

Clarify the requirements for board and mechanical work, and add a mechanical quickstart covering existing STEP/GLB files, the mech/ parts list, renders, FreeCAD discovery, and an example modelling prompt. The guide also states the current format and geometry-comparison limits.

Validation: checked the documented behavior and UI labels against the project-creation, Mech, viewer tool, FreeCAD-discovery and history code; verified local Markdown link targets; git diff --check passed. Documentation only; application builds and end-to-end tests were not run.

i2cjak and others added 30 commits October 16, 2026 12:56
Mail bodies on disk: per-conversation journal, crash recovery
…opy link

Card.of resolves every kind with map gets only; Cards caches them and
drops by the object ids an event touches (reverse index, no walks).
Trail keeps back/forward in the Ui scratch; ref-go/ref-back/ref-fwd
navigate through the existing select/bot/room/project/file handlers;
ref-copy/ref-copy-web and Copy link in the thread, project, bot and
file menus.
Links: refs resolve to live cards; back/forward; ref-go; Copy link
Hub.prompt is Hub.prompt.base plus the optional language line, so the test
checks the off setting byte for byte against the base as it is now and
does not break when other prompt text changes.
…anguage follows a change

The window's Language chips are right-aligned to the card like Theme's, the
agent row is an On/Off pair like the notification rows, and both rows have
a note. Changing this device's language while "Agents reply in my language"
is on moves agent.lang to the new language.
Language setting on every client, and agents can reply in your language
…warm

boat-job: warm sandbox per thread (reuse, idle window, start guard); PROOF on large by default
Short ages say 前 (3分前, not a bare duration), the delete question is
polite, files changed is a label, the author label is 自分, a routine whose
time has come is 実行時刻です, and the agent-language row says which
language. docs/i18n/glossary-ja.md holds the terms and the spacing and
punctuation rules. English is unchanged.
…ords

Japanese wording from an independent review, and the glossary
A small Python service (order/fabsrv) the hub talks to: /v1/estimate prices
bare parts from their features, /v1/quotes takes a manifest and files,
measures them in a sandboxed process (gerbers, drills, BOM, positions, STEP,
DXF), sources components, adds shipping, duties and the fee, and serves a
quote page whose Pay opens Stripe Checkout. Rate limits per address and
install, read tokens kept hashed. The fab's price models are a private pack
loaded from FAB_VENDOR.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Mailroom view model (pure, shared by all clients)
core/order.bend: the intent (.backplane/intent.md) and fab files (*.fab.json)
read into a card with the order server's price for the bare parts; every
agent is told to keep both, and a buy thread (Buy it: setting buy.<thread>)
gets its own instructions and the order_quote/order_status tools. The hub
(server/orderio.bend) asks the person with every file listed before it
uploads, waits for the quote, posts it with its Pay link, and follows the
order until it is delivered (records in <home>/orders, resumed at start).
Agents also get the free pcbparts MCP for parts by part number.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Every client shows the intent's goal above a project thread with Edit
(the intent into the composer; /intent sends it back) and Buy it with its
price; the window and the web open the whole intent, the phones show it
as a row above the composer (bundled bridge only, no native code).
Settings has Price estimates on all four. Laws order_buy_*, intent_edit_*,
order_tools_buy_only.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
…-local

docs/boat.md: no local-lock wording; PROOF's 8.52 GB peak
…aw it start; counting starts again under an epoch; unknown turns said so
…eline-fix

Usage: no turn is charged what its process or session did before the hub saw it start
…the review, tappable questions

The quote's board price takes the via tier its smallest plated hole needs
(a 0.2 mm via costs more than a 0.3 mm one); fab.json may say min_drill_mm
for the estimate. The buy agent reviews against the fab's real track, gap
and via limits, and asks its questions with AskUserQuestion. The upload's
approval card asks "Send these files for a quote?", and the intent file
is written readable like any project file.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
…ts, address) and the files as a zip

Co-Authored-By: Claude Opus 5.5 <[email protected]>
…y it

The card counts the project's KiCad boards when no part has a fab file
(and checks the order server is there); the buy agent writes the missing
fab files first. Laws order_buy_board_only, order_buy_board_unreachable.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
… a line when a quote expires

Co-Authored-By: Claude Opus 5.5 <[email protected]>
i2cjak and others added 25 commits October 18, 2026 16:33
…ve-thread

Localize native project thread and composer labels
perf(window): retain exact visible sidebar row paint
…ve-cards

Localize native thread cards and bound catalog metadata
…ve-plane

Localize native Home and Status labels
…ve-settings-labels

Localize native hub settings and notification channels
…permission-resources

Generate localized iOS camera permission resources
…at-cache

perf(window): cache cats requested by visible layouts
Add native bot Mailroom with virtualized conversations
Reuse the maintained sidebar index for Mailroom plane refresh
…boundaries

Enforce browser origin checks and protect hub pairing credentials
Render PCB text in native and remote 2D viewers
@i2cjak

i2cjak commented Nov 2, 2026

Copy link
Copy Markdown
Collaborator

Integrated the remaining mechanical-only quickstart via #738 (9b31f10), preserving contributor authorship while keeping the current platform README and clarifying STEP conversion requirements.

@i2cjak i2cjak closed this Nov 2, 2026
fine-grain-solutions pushed a commit to fine-grain-solutions/Backplane that referenced this pull request Nov 2, 2026
Extract and adapt the still-missing guide from PR BackplaneWorks#221 without replacing the current platform installation README.
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.

4 participants