Skip to content

docs: explain stage_pipeline usage and build dependencies - #942

Merged
zzylol merged 2 commits into
mainfrom
docs/stage-pipeline-usage
Oct 26, 2026
Merged

zzylol merged 2 commits into
mainfrom
docs/stage-pipeline-usage

Conversation

@zzylol

@zzylol zzylol commented Oct 26, 2026

Copy link
Copy Markdown
Contributor

Before this PR

A user running stage_pipeline --workload ... --search memo-milp can encounter command not found, an unsupported search name, or a missing --out. First-time native builds can fail when bindgen cannot find libclang. The viewer guide also describes an obsolete search workflow.

After this PR

A dedicated user guide explains Cargo and direct-binary invocation, native build dependencies, workload-file planning, accuracy enforcement, deployment capabilities, planning budgets, output inspection, and libclang troubleshooting. The user-guide index and CLI guide link to it, and the viewer guide describes the current candidate-connection engine and bounded archive mode.

Key code interfaces added / modified

None; documentation only.

Major algorithm changes

None.

Validation

  • Ran the documented quick-start planner arguments using the existing debug binary: selected plan present, accuracy enforced, no Stage 3 error.
  • Checked CLI options against the current parser and verified new guide links.
  • Loaded the reported node's existing libclang shared library successfully.
  • git diff --check passes. No release rebuild or dependency installation was performed.

@zzylol
zzylol merged commit 7680b6b into main Oct 26, 2026
1 check passed
@zzylol
zzylol deleted the docs/stage-pipeline-usage branch October 26, 2026 21:58
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