beffroi-reporting/README.md

1.7 KiB

Beffroi Reporting

Beffroi Reporting is the integration workspace for the Beffroi diagnostics and reporting toolchain.

It brings the complete environment together as Git submodules:

beffroi-reporting
├── win-diagnostics/
├── beffroi-reports/
└── reportist/

The target layout uses diagnostics/, reports/, and reporter/ respectively. Renaming the current submodule paths is tracked in the migration roadmap.

During migration, the previous implementations are also available under references/ so developers and agents can inspect the complete old and new workflows from one workspace.

The target pipeline is:

Windows
   ↓
win-diagnostics
   ↓
diagnostic.json
   ↓
beffroi-reports
   ↓
report.yaml
   ↓
reportist
   ↓
PDF

Getting started

Clone the complete workspace with its submodules:

git clone --recursive <repository-url>
cd beffroi-reporting

For an existing checkout:

git submodule update --init --recursive

Status

🚧 Architecture migration in progress

AGENTS-TASKS.md tracks completed work, remaining migration passes, acceptance criteria, and the next-pass handoff. AGENTS.md defines repository ownership and rules for agents working across the workspace.

The first executable migration check is the synthetic legacy baseline. It records diagnostic behavior and renders example PDFs before extraction.

License

Root-level software and orchestration code is licensed under the MIT License.

Internal Beffroi data and content remain proprietary where applicable; see LICENSE-DATA.md.