Documentation

The written guides, the generated catalogs and the API reference all live at docs.teksilo.rs, and the same guides ship inside the repository so you can read them from a checkout.

The guides and the generated catalogs are at docs.teksilo.rs, and the rustdoc API reference sits under /api/ on the same site. The guides and the catalog pages are plain Markdown in the repository under docs/, so a checkout gives you both without a browser.

Start here

Eight guides carry most of the weight. Read the two or three that match what you are building.

• Architecture. How the arena, the render pipeline, scrolling, HiDPI and threading fit together. Read it when you are debugging the engine or porting it, not when you want to use a feature.
• Layout primitives. The two-phase size negotiation, grow and shrink weights, height-for-width. Read it before you fight a stack.
• Events and gestures. Attached handlers, the preview and bubble passes, and how raw input, recognized gestures and accessibility actions all reach the same widget.
• Styling system. The four tiers: tokens, variants, recipes, style protocols. Read it when the default look is close but not what you want.
• Shortcuts, intents and actions. How a keystroke becomes behavior, and how a user rebinds it without your handler code changing.
• Data models. ListModel, TreeModel, selection, and the sort and filter projections. Read it before you put anything in a list, tree or table.
• Internationalization. Fluent messages validated at compile time, locale resolution, and locale-aware number and date formatting.
• Accessibility overrides. Labels, roles, relations and subtree control for the cases where a widget’s own accessibility output is not what you meant.

Reference

The Widget Catalog is one page per widget, generated from the source: the module’s own documentation, the public types, and the builder methods you can actually call. Each page links into the matching rustdoc module, and the full API reference is at /api/teksilo_widgets/.

Three more catalogs are generated the same way from the crates beside the widgets:

• Data collections. The teksilo-data models: the list, tree and chart models, selection, checked state, and the sort and filter projections.
• Settings. The teksilo-settings surface: application paths, the store, the typed settings file, the MRU list and per-window state.
• Scene. The teksilo-scene surface: the scene and its model, the item types, magnets, the minimap and the spatial index.

Offline

cargo install mdbook          # once
git clone https://github.com/ferntech-eu/teksilo
cd teksilo
mdbook serve --open           # the guides and the catalogs
cargo doc --no-deps --open    # the API reference

The catalog pages are committed, so the book builds on a fresh clone with no generator step.

For what the framework does and the gaps it still has, read the tour. For a first window on screen, get started.