Skip to content

docs: separate offline quick start from model setup - #10

Merged
rustfuture merged 1 commit into
mainfrom
docs/quickstart-usability
Oct 2, 2026
Merged

rustfuture merged 1 commit into
mainfrom
docs/quickstart-usability

Conversation

@rustfuture

@rustfuture rustfuture commented Oct 2, 2026 •

Copy link
Copy Markdown
Owner

Add clone/build prerequisites and explain the snapshot and source-reference outputs. Keep offline retrieval in the first command block and move model-assisted answers into an explicitly optional section with setup guidance.

Validation

All listed checks completed locally with exit code 0. Run output paths used temporary directories to preserve committed evidence.

git diff --check
cargo fmt --check
cargo check --locked --all-targets
cargo clippy --locked --all-targets -- -D warnings
cargo test --locked
cargo build --locked
cargo run --locked -- --help
cargo run --locked -- --index evaluation/corpus /var/folders/v1/5g8zpd5j0h56kyw4dn14f_g40000gn/T/portfolio-quickstart-c03_zqaj/ri.ri
cargo run --locked -- --semantic evaluation/corpus "index header"
cargo run --locked -- --hybrid evaluation/corpus "index header"
cargo run --locked -- --load-index /var/folders/v1/5g8zpd5j0h56kyw4dn14f_g40000gn/T/portfolio-quickstart-c03_zqaj/ri.ri "index header"

Offline commands were exercised; optional Ollama/model calls and Windows were not run.

@rustfuture
rustfuture merged commit f53acd8 into main Oct 2, 2026
2 checks passed
@rustfuture
rustfuture deleted the docs/quickstart-usability branch October 2, 2026 08:39
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