# Immersive documentation

> Human documentation for users of the Immersive IL weaver and for its maintainers, exported from the same content as the website.

Documented version: main · v2.1 (preview). Use documentation from the relevant checkout when working on another branch or version.

The links below point to Markdown exports. Audience, kind and status describe each page independently. This index follows the llms.txt discovery proposal; repository instructions remain in AGENTS.md.

## Users and maintainers

- [Documentation](https://docs.allors.com/immersive/index.md): Documentation for users of the Immersive IL weaver and for its maintainers. Audience: Users and maintainers; Kind: Index; Status: Current; Version: main · v2.1 (preview).
- [Terminology](https://docs.allors.com/immersive/terminology.md): Agreed names for the assemblies, the marker, substitutions and the testing libraries. Audience: Users and maintainers; Kind: Reference; Status: Current; Version: main · v2.1 (preview).

## Users

- [Attributes](https://docs.allors.com/immersive/attributes.md): SubstituteClassAttribute and SubstituteMethodAttribute: constructors, properties and the rules the weaver applies to them. Audience: Users; Kind: Reference; Status: Current; Version: main · v2.1 (preview).
- [Test an Avalonia application](https://docs.allors.com/immersive/avalonia.md): Weave an Avalonia application with the Avalonia library, run it on the headless platform, and find and drive its controls from tests. Audience: Users; Kind: How-to guide; Status: Current; Version: main · v2.1 (preview).
- [Substituted controls and testers](https://docs.allors.com/immersive/controls.md): Every substituted Windows Forms and Avalonia type, its tester, the events it reports and the members its tester adds. Audience: Users; Kind: Reference; Status: Current; Version: main · v2.1 (preview).
- [Getting started](https://docs.allors.com/immersive/getting-started.md): Weave a console application so that a library it uses is replaced by substitutes, first by hand with the immerse command and then as part of the build. Audience: Users; Kind: Tutorial; Status: Current; Version: main · v2.1 (preview).
- [Packages, tool and task](https://docs.allors.com/immersive/packages.md): The NuGet packages and their target frameworks, the immerse command, the MSBuild task, the ModuleWeaver API and the messages the weaver writes. Audience: Users; Kind: Reference; Status: Current; Version: main · v2.1 (preview).
- [Run the weaver](https://docs.allors.com/immersive/run-the-weaver.md): Run the immerse command by hand or from a build target, use the weaver's API, keep the marker out of Release builds, and know the state of the MSBuild package. Audience: Users; Kind: How-to guide; Status: Current; Version: main · v2.1 (preview).
- [How weaving works](https://docs.allors.com/immersive/weaving.md): The three assemblies, the marker, base and explicit class substitution, method substitution, and what the weaver rewrites and leaves alone. Audience: Users; Kind: Explanation; Status: Current; Version: main · v2.1 (preview).
- [Test a Windows Forms application](https://docs.allors.com/immersive/winforms.md): Weave a Windows Forms application with the Winforms library, then find its controls by name and drive forms, dialogs and message boxes from tests. Audience: Users; Kind: How-to guide; Status: Current; Version: main · v2.1 (preview).

## Maintainers

- [Build and release](https://docs.allors.com/immersive/internals/build-and-release.md): Prerequisites, the Nuke targets, the test suites and which ones CI runs, packaging, versioning and publication to NuGet. Audience: Maintainers; Kind: How-to guide; Status: Current; Version: main · v2.1 (preview).
- [Documentation website](https://docs.allors.com/immersive/internals/documentation-website.md): The adoption of the Allors3 documentation standard for Immersive, what was reused, how it was validated, and where the website is published. Audience: Maintainers; Kind: Decision record; Status: Current; Version: main · v2.1 (preview).
- [Weaver internals](https://docs.allors.com/immersive/internals/weaver.md): The classes of the weaving engine, the order of its passes over a type, assembly resolution, the test fixture, the known limitations and the validated change to the MSBuild package. Audience: Maintainers; Kind: Explanation; Status: Current; Version: main · v2.1 (preview).
- [Writing documentation](https://docs.allors.com/immersive/internals/writing-documentation.md): Write and review documentation for its audience, purpose, status, terminology and visual explanation. Audience: Maintainers; Kind: How-to guide; Status: Current; Version: main · v2.1 (preview).