Skip to content

docs: add mdBook user guide and Pages publishing#1

Merged
shinaoka merged 8 commits intomainfrom
docs/user-guide
Mar 26, 2026
Merged

docs: add mdBook user guide and Pages publishing#1
shinaoka merged 8 commits intomainfrom
docs/user-guide

Conversation

@shinaoka
Copy link
Copy Markdown
Member

Summary

  • add an mdBook-based Rust user guide covering the same topics as the Julia guide
  • validate guide examples through compiled source files and add docs checks to CI
  • publish the user guide to GitHub Pages and finalize crate dual-licensing metadata

Test Plan

  • cargo fmt --all -- --check
  • cargo clippy --all-targets -- -D warnings
  • cargo nextest run --release
  • cargo test --doc
  • ./scripts/test-book-examples.sh
  • mdbook build

@shinaoka shinaoka enabled auto-merge (squash) March 26, 2026 03:29
@shinaoka shinaoka merged commit 7836b2a into main Mar 26, 2026
4 checks passed
@shinaoka shinaoka deleted the docs/user-guide branch March 26, 2026 03: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