# Reports

## `reports/errors.md`

- Purpose: validation report for customer code and repository files
- Generated by: `tools/validate-code.sh`
- Typical contents: validation summary, files checked, warnings, errors, detailed per-file results

## `reports/project-flow.md`

- Purpose: best-effort project flow analysis
- Generated by: `tools/project-report.sh`
- Typical contents: likely entry point, possible startup files, detected frameworks, detected databases, probable application flow

## `reports/file-summary.md`

- Purpose: repository structure summary
- Generated by: `tools/project-report.sh`
- Typical contents: top-level folders, file counts by type, largest source directories

## `reports/languages.md`

- Purpose: language inventory
- Generated by: `tools/project-report.sh`
- Typical contents: counts for supported source and config languages

## `reports/summary.md`

- Purpose: single high-level automation snapshot
- Generated by: `tools/project-report.sh`
- Typical contents: generation time, repo name, branch, commit, generated files, customer code status, overview, language counts, likely entry points, frameworks, databases

## `reports/generated-files.md`

- Purpose: explicit list of report files created or updated during the run
- Generated by: both scripts
- Typical contents: markdown list of generated report files

## `reports/customer-code-status.txt`

- Purpose: single-line machine-readable customer code status
- Generated by: `tools/validate-code.sh`
- Typical contents: `CUSTOMER CODE ERRORS FOUND` or `NO CUSTOMER CODE ERRORS FOUND`

## `reports/api-reference.md`

- Purpose: at-a-glance reference of detected functions, methods, classes, and public APIs
- Generated by: `tools/generate-code-docs.sh`
- Typical contents: file path, language, class, function/method name, parameters, return type, visibility, static/async markers, guessed purpose, parsing notes

## `reports/file-purpose.md`

- Purpose: file-by-file summary for quick customer project review
- Generated by: `tools/generate-code-docs.sh`
- Typical contents: file path, language, line count, detected classes, detected functions, imports/includes, possible purpose, likely role notes

## `reports/unity-scripts.md`

- Purpose: Unity-specific lifecycle and script role map
- Generated by: `tools/generate-code-docs.sh`
- Typical contents: MonoBehaviour/ScriptableObject classes, lifecycle methods, serialized/public fields, public methods, Unity API usage, possible script role

## `reports/call-map.md`

- Purpose: best-effort static map of possible entry points, imports/includes, function definitions, call references, and relationships
- Generated by: `tools/generate-code-docs.sh`
- Typical contents: possible entry points, detected imports, function definitions, possible calls, relationship guesses, limitations

## `reports/code-docs-summary.md`

- Purpose: concise summary of the code documentation generation run
- Generated by: `tools/generate-code-docs.sh`
- Typical contents: reports written, source files scanned, functions/methods detected, classes detected, Unity scripts detected, possible entry points, detected code types