Skip to content

docs: add a headless first-run example and exit guidance - #14

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

Copy link
Copy Markdown
Owner

Document build prerequisites and q to exit the dashboard. Add a local JSON/CSV export example for users without an interactive terminal and explain the output paths and platform limits.

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 -- export --json /var/folders/v1/5g8zpd5j0h56kyw4dn14f_g40000gn/T/portfolio-quickstart-c03_zqaj/grainx-stats.json --csv /var/folders/v1/5g8zpd5j0h56kyw4dn14f_g40000gn/T/portfolio-quickstart-c03_zqaj/grainx-stats.csv

Interactive dashboard opened in a PTY and q exited with code 0; exported JSON decoded and CSV rows were checked. Windows was not run.

@rustfuture
rustfuture merged commit c58144d into main Oct 2, 2026
4 checks passed
@rustfuture
rustfuture deleted the docs/quickstart-usability branch October 2, 2026 08:40
Repository owner deleted a comment from coderabbitai Bot Oct 2, 2026
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