Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Univis UI Docs

This unified documentation book contains both language editions:

Use the language switcher shown at the top of each page to jump to the mirrored chapter in the other language.

Structure

  • ar/ contains the Arabic documentation tree
  • en/ contains the English documentation tree
  • both trees share the same chapter map and live in one mdBook
  • hosted docs URL: https://univiseditor.github.io/univis_ui/

Guides vs API Docs

  • Use the guide chapters for mental models, migration notes, and example-driven learning.
  • Use generated rustdoc for exact type paths, field lists, and signatures.

Generate API docs with:

cargo doc --no-deps -p univis_ui

Build

mdbook build docs

Serve

mdbook serve docs -n 127.0.0.1 -p 3000