36 lines
1.2 KiB
Markdown
36 lines
1.2 KiB
Markdown
# Repository Map
|
|
|
|
## Top-Level Structure
|
|
|
|
- `.forgejo/workflows/`
|
|
Purpose: Forgejo Actions workflow definitions
|
|
- `tools/`
|
|
Purpose: validation and report-generation scripts
|
|
- `reports/`
|
|
Purpose: generated markdown and status outputs
|
|
- `tests/validation-samples/`
|
|
Purpose: intentional valid and broken sample files for validator behavior
|
|
- `docs/`
|
|
Purpose: authoritative repository documentation
|
|
|
|
## Scripts
|
|
|
|
- `tools/validate-code.sh`
|
|
Purpose: run validators, write `reports/errors.md`, and keep customer code errors non-fatal
|
|
- `tools/project-report.sh`
|
|
Purpose: generate structural and summary reports
|
|
- `tools/generate-code-docs.sh`
|
|
Purpose: generate API, file-purpose, Unity lifecycle, and call-map documentation reports
|
|
|
|
## Workflows
|
|
|
|
- `.forgejo/workflows/validate.yml`
|
|
Purpose: run validation and print the validation report into Forgejo logs
|
|
- `.forgejo/workflows/project-report.yml`
|
|
Purpose: generate project analysis reports and print useful summaries into Forgejo logs
|
|
- `.forgejo/workflows/code-docs.yml`
|
|
Purpose: generate code documentation reports and print useful summaries into Forgejo logs
|
|
|
|
## Customer Code
|
|
|
|
Customer source files may be broken on purpose. They are analyzed and reported on, not treated as workflow-breaking by default.
|