# Release Doctor — Quick Start

Run configurable project checks, review findings, and export reports for editor and CI workflows.

## Requirements and scope

- Editor baseline: Unity 2022.3 LTS; consult the listing for the supported release
- Requirements: TextMeshPro for relevant checks; Test Framework only for included tests
- Reports: HTML, JSON, text, and JUnit
- Audit behavior: Reports findings without modifying project assets

Current size baselines measure files under Assets, not platform player-build size. An audit does not guarantee a bug-free release, certification, or marketplace approval.

## Setup

1. Import Assets/UnityReleaseDoctor and read Documentation/QuickStart.md.
2. Open Tools > Unity Release Doctor > Open Auditor. Select or create an AuditConfiguration.
3. Run a full audit, inspect the findings, and document intentional exceptions with suppressions.
4. Export a report. Use Documentation/CIIntegration.md to configure batch-mode execution and its exit codes.

## API excerpt

Illustrative excerpt; assign the referenced components in your project.

```text
// CI entry point documented in the package:
Jackmirza.ReleaseDoctor.UnityReleaseDoctorCI.RunAudit

// Exit codes: 0 = no blocking findings,
// 1 = blocking findings, 2 = execution/configuration failure.
```

## Current release and support

[Marketplace listing](https://assetstore.unity.com/packages/tools/utilities/release-doctor-project-auditor-ci-validator-399682)

The package includes detailed offline documentation. For support, email erenmyeager15@gmail.com with the product/version, editor, input module, pipeline, platform, and reproduction steps.

Prepared 2026-10-16. Marketplace release notes remain the reference for the shipped version.