# Rekindle v0.1.7 - Table of Contents

> Elixir build system and development runtime for Rust UI applications.

## Pages

- [Rekindle](readme.md)
- [Changelog](changelog.md)

- Introduction
  - [Getting Started](getting-started.md)
  - [How Rekindle Works](how-rekindle-works.md)

- Features
  - [Plugins](plugins.md)
  - [Configuration](configuration.md)
  - [Development](development.md)
  - [Web Target](web-target.md)
  - [Desktop Target](desktop-target.md)

- Deployment
  - [Production Builds](production-builds.md)

- Reference
  - [Troubleshooting](troubleshooting.md)
  - [cli](cli.md)

## Modules

- Core
  - [Rekindle](Rekindle.md): Elixir build system and development runtime for Rust UI applications.

  - [Rekindle.DevServer](Rekindle.DevServer.md): Plug that serves Rekindle Web generations during development.
  - [Rekindle.Phoenix](Rekindle.Phoenix.md): Connects Rekindle's Web artifacts to a Phoenix endpoint.

- Plugins
  - [Rekindle.Install](Rekindle.Install.md): Installs Rekindle and generates the selected plugin's Rust client.
  - [Rekindle.Plugin](Rekindle.Plugin.md): Contract for a Rust UI framework supported by Rekindle.
  - [Rekindle.Plugin.Cargo](Rekindle.Plugin.Cargo.md): Cargo manifest data declared by a Rekindle plugin.
  - [Rekindle.Plugin.Cargo.Dependency](Rekindle.Plugin.Cargo.Dependency.md): One Cargo dependency declared by a plugin.
  - [Rekindle.Plugin.Egui](Rekindle.Plugin.Egui.md): Built-in egui/eframe support.
  - [Rekindle.Plugin.GPUI](Rekindle.Plugin.GPUI.md): Built-in GPUI support.
  - [Rekindle.Plugin.Slint](Rekindle.Plugin.Slint.md): Built-in Slint support.
  - [Rekindle.Plugin.Spec](Rekindle.Plugin.Spec.md): Declarative requirements for one Rust UI plugin.
  - [Rekindle.Plugin.Spec.Web](Rekindle.Plugin.Spec.Web.md): Browser host requirements declared by a plugin.
  - [Rekindle.Priv](Rekindle.Priv.md): Resolves files owned by an OTP application's `priv` directory.

- Build results
  - [Rekindle.Build.Result](Rekindle.Build.Result.md): The artifact and metadata returned by `Rekindle.build/2`.
  - [Rekindle.Diagnostic](Rekindle.Diagnostic.md): A structured compiler or Cargo diagnostic returned by a build.

- Errors
  - [Rekindle.Build.Error](Rekindle.Build.Error.md): Reports an invalid build target, profile, entry, or invocation.

  - [Rekindle.Cargo.Error](Rekindle.Cargo.Error.md): Reports Cargo metadata, compilation, process, or artifact selection failures.
  - [Rekindle.Config.Error](Rekindle.Config.Error.md): Reports invalid or missing Rekindle project configuration.

  - [Rekindle.Desktop.Error](Rekindle.Desktop.Error.md): Reports desktop artifact validation, publication, or launch failures.

  - [Rekindle.Toolchain.Error](Rekindle.Toolchain.Error.md): Reports Cargo or pinned Web tool discovery and installation failures.

  - [Rekindle.Web.Error](Rekindle.Web.Error.md): Reports Web packaging, manifest validation, or publication failures.

## Mix Tasks

- Mix Tasks
  - [mix rekindle.build](Mix.Tasks.Rekindle.Build.md): Builds one enabled Rust UI target without starting it.
  - [mix rekindle.check](Mix.Tasks.Rekindle.Check.md): Checks the generated Rust UI project with its declared Cargo toolchain.
  - [mix rekindle.dev](Mix.Tasks.Rekindle.Dev.md): Starts the Rekindle file watcher and development builders without starting an
HTTP server.
  - [mix rekindle.doctor](Mix.Tasks.Rekindle.Doctor.md): Checks the Rekindle configuration and target prerequisites without changing
the project.
  - [mix rekindle.install](Mix.Tasks.Rekindle.Install.md): Installs Rekindle through Igniter and generates its Rust client.
  - [mix rekindle.setup](Mix.Tasks.Rekindle.Setup.md): Installs the declared prerequisites for enabled Rust UI targets.

