feresaria/docs

Documentation

These guides describe the development version on main. For the packaged 0.1.0-beta, use the release notes and guides at that tag.

Usage

• Installation: install dependencies, log in, preview changes, update and recover a session.
• Why Ferese: window layouts and a shared theme for the desktop.
• Screenshots: see the themes, overview and shell controls.
• Live Activities: show running commands in the panel, configure detection and troubleshoot missing tasks.
• Shortcuts and gestures: keyboard navigation, moving and resizing with Super-drag, and window grouping.
• Tabbed windows: group windows, select tabs and switch scrolling columns between tabs and rows.
• Lock screen: change its appearance, set up automatic locking and configure display sleep.
• Screen sharing and recording: choose a source and stop sharing.
• Desktop portals: services available to applications.
• feresectl and IPC events: query the desktop, target a session and follow changes.

Configuration

• Introduction: KDL syntax, loading and validation.
• Layout.
• Animations.
• Appearance.
• Workspaces.
• Input.
• Commands and bindings.
• Window rules.
• Outputs.
• Panels.
• Panel options and examples.
• Activities.
• Status controls.
• Startup, locking and logout.
• Idle inhibition.
• Session protocols.
• Xwayland.

Development

• Packages and releases: build Fedora and Arch packages and publish a tagged release.
• Development: build Ferese, run tests and check portal contracts.
• Publishing activities: IPC schema, ownership, limits and templates.
• Rust style: module boundaries, ownership, API contracts and enforced checks.
• Animation model: geometry, spring motion, gestures and prediction.
• Rendering diagnostics: outcome counters, capture cost and repeatable hardware baselines.
• Output management tests: profiles, hotplug and DRM failures.
• Client soak testing.
• Website development.
• Theme components: shared native UI styles.