43 lines
1.6 KiB
Markdown
43 lines
1.6 KiB
Markdown
# Customer-Test Documentation
|
|
|
|
## Purpose of Repository
|
|
|
|
This repository is the master template for Runlevel Systems DevPlus1 customer debugging and analysis projects.
|
|
|
|
Customers are expected to upload code that may already be broken. The repository automation is designed to inspect that code, generate reports, and keep the workflows green when the automation itself succeeds.
|
|
|
|
## Purpose of DevPlus1 Customer Debugging
|
|
|
|
DevPlus1 customer debugging projects need fast, repeatable automation that:
|
|
|
|
- validates customer code where supported
|
|
- reports errors clearly
|
|
- analyzes project structure
|
|
- generates documentation-friendly markdown output
|
|
- does not confuse customer code problems with automation failures
|
|
|
|
## Repository Goals
|
|
|
|
- Make Forgejo Actions useful for debugging projects.
|
|
- Generate reports on every push and pull request when possible.
|
|
- Keep customer code errors visible in logs and markdown.
|
|
- Reserve red workflows for automation failures only.
|
|
- Provide documentation that future Codex sessions can read first.
|
|
|
|
## High-Level Workflow
|
|
|
|
1. Customer code is pushed to the repository.
|
|
2. `validate.yml` runs validation and writes `reports/errors.md`.
|
|
3. `project-report.yml` generates structure and flow reports in `reports/`.
|
|
4. Forgejo logs print report summaries directly.
|
|
5. A developer or future Codex session reviews the reports before deeper work.
|
|
|
|
## Documentation Index
|
|
|
|
- [CODEX_INSTRUCTIONS.md](./CODEX_INSTRUCTIONS.md)
|
|
- [ARCHITECTURE.md](./ARCHITECTURE.md)
|
|
- [WORKFLOWS.md](./WORKFLOWS.md)
|
|
- [REPORTS.md](./REPORTS.md)
|
|
- [VALIDATORS.md](./VALIDATORS.md)
|
|
- [REPOSITORY_MAP.md](./REPOSITORY_MAP.md)
|
|
- [AUTOMATION.md](./AUTOMATION.md)
|