README.md

Decouple Documentation

The documentation is split in four categories, following the Grand Unified Theory of Documentation:

• Tutorials demonstrate the usage of the library, skipping the setup steps,
• Explanations present the underlying guidelines and our high-level goals, as well as explain technical decisions,
• How-to guides are small commented examples of how to solve specific problems,
• The reference is a low-level precise explanation of the API elements and how to use them.

Tutorials

• Introduction to Compose with Decouple

Explanations

Project origin and identity:

• Comparison with other Compose-based projects
• High-level goals

Project organization:

• How are tasks organized?
• How can I contribute?

How-to guides

In the future, this section will have guides to set a new project with Decouple.

The reference

The reference is documented directly in the code using KDoc. Comments are extracted and generated into a static website using Dokka.

To browse the generated site for the latest Decouple version, click here.

To generate the site for any other version, clone the repository, run the command ./gradlew dokkaHtmlMultiModule and look into build/dokka/htmlMultiModule.