AutoForge/README.md

160 lines
7.3 KiB
Markdown

# AutoForge
## Product vision
The following describes the product vision, not implemented capabilities:
AI-assisted automotive diagnostics and programming platform. Read and back up
vehicle data or build AI-researched vehicle profiles. Simulate control modules
and driving scenarios, replay telemetry, and test calibration changes before
real-world programming. Diagnose faults, read/clear trouble codes, and program
supported vehicle modules.
## Implementation status
### Implemented
- Step-01 platform-neutral Core/Application foundation and regression coverage.
- Step-01A single Windows-first .NET 10 MAUI Blazor Hybrid Client, UI and generic
Components RCLs. Step-01A was accepted by the orchestrator on 2026-10-28.
- Step-02 validated vehicle/profile/module metadata, strict schema-v1 JSON
interchange, an in-memory revision catalog, and a synthetic profile UI.
Step-02A corrected strict timestamp parsing and optional evidence applicability.
Both worker implementation/verification runs are complete; manual orchestrator
acceptance of Step-02 remains pending.
- UI routes: `/` foundation, `/execution-targets` explicit metadata selection,
`/vehicle-profiles` explicit profile import/revision selection/inspection/export,
and a visible not-found route.
- Capability declarations distinguish Supported, Unsupported, Unknown,
Inaccessible and Restricted. Missing declarations are explicitly Unknown.
Provenance and all profile facts are supplied metadata, not independently
verified truth or permission.
- Profile import is atomic and unknowns remain explicit. A selected profile is
immutable, process-local metadata; it is not connected to a vehicle.
- Publication/retrieval timestamps require a complete date/time with seconds and
an explicit `Z` or signed `HH:mm` offset; partial dates/times and local-time
defaults are rejected. A null optional module identity in evidence is no
constraint; supplied values must match a known module identity and never fill
unknown module data. See the schema guide for exact grammar and limits.
### In progress
Manual orchestrator review and acceptance of Step-02 after the Step-02A correction.
### Planned
Vehicle/module discovery, deterministic simulation, diagnostics, telemetry and
replay, calibration values/editing/backups, AI and real hardware operations
require later approved assignments. No capability is implemented merely because
it appears in the product vision or roadmap. Initial future hardware integration
remains read-only; any programming requires separate authorization and evidence.
## Architecture
One Windows-first **AutoForge.Client** .NET 10 MAUI Blazor Hybrid executable hosts
the application UI via `BlazorWebView`. **AutoForge.UI** owns all routes,
navigation, layouts and feature presentation. **AutoForge.Components** owns
vehicle-independent reusable controls. Application features run in-process in a
modular monolith, and Core remains platform-neutral. There is no backend,
browser-hosted WASM shell, Blazor Server host or second application executable.
The application slices currently provide explicit target metadata resolution
and vehicle-profile metadata import/list/select/export. The Client composes an
empty target-provider registration and a session-lifetime in-memory profile
catalog. Import never auto-selects, replaces an existing profile revision, or
changes target selection.
```mermaid
flowchart TD
Client[MAUI Blazor Hybrid Client] --> UI[UI RCL]
UI --> Components[Reusable Components RCL]
UI --> App[Application feature slices]
Client --> App
App --> Core[Platform-neutral Core models]
UnitTests[Headless unit tests] --> Core
UnitTests --> App
IntegrationTests[Headless integration and rendered UI tests] --> UI
IntegrationTests --> App
IntegrationTests --> Core
```
Core and Application own their behaviors under feature-focused source folders:
- `AutoForge.Application/Features/ExecutionTargets/SelectExecutionTarget`
- `AutoForge.Application/Features/Vehicles/Profiles`
- `AutoForge.UI/Features/Vehicles/Profiles`
No mediator, generic repository layer, database, or empty future feature is
required. See the [schema-v1 profile guide](docs/vehicle-profile-schema-v1.md)
for stable identifiers/revisions, unknown values, capabilities, provenance and
the strict JSON contract.
## Repository layout
Only `docs`, `src` and `prompts` are top-level project directories. Tests and
synthetic fixtures remain under `src/tests`. No nested repository or root test
project is used.
```text
AutoForge/
docs/ Technical docs, schemas and ADRs
prompts/ Manual assignments, state and worker reports
src/
AutoForge.slnx
AutoForge.Client/ Sole Windows MAUI Hybrid executable
AutoForge.UI/ Application routes and feature presentation
AutoForge.Components/ Generic reusable UI components
AutoForge.Core/ Platform-neutral domain invariants
AutoForge.Application/ In-process application feature slices
tests/
AutoForge.UnitTests/
AutoForge.IntegrationTests/
Fixtures/ Clearly synthetic schema-v1 JSON only
```
## Build, test and run
Verified Windows prerequisites: .NET SDK **10.0.402**, runtime **10.0.13**,
Windows SDK target **10.0.26100.0**, `maui-windows` workload manifest **10.0.110**
and WebView2 Runtime **155.0.4283.62**. The Client targets
`net10.0-windows10.0.26100.0`/`win-x64`; the other projects target portable
`net10.0`. No automotive driver, actual vehicle, AI model, database, backend or
cloud account is needed.
From the repository root in PowerShell:
```powershell
dotnet restore .\src\AutoForge.slnx
dotnet build .\src\AutoForge.slnx --configuration Release
dotnet test .\src\AutoForge.slnx --configuration Release
dotnet run --project .\src\AutoForge.Client\AutoForge.Client.csproj --configuration Release --framework net10.0-windows10.0.26100.0
```
Step-02A worker verification includes a seven-project Release build with zero
warnings/errors, 103 unit and 37 integration tests passed (140 total, zero
failed/skipped), and native Client checks for strict timestamp failures, partial
evidence import/export and conflicting-identity atomicity. The original Step-02
report records its historical 59 unit/34 integration cases; those runs did not
include the Step-02A corrections. Exact commands and evidence are in the
[Step-02A report](prompts/Step-02A-Report.md). Manual orchestrator acceptance
remains pending.
## Documentation and handoff
- [Documentation index](docs/README.md)
- [Architecture and project graph](docs/architecture.md)
- [Vehicle-profile schema v1 and usage](docs/vehicle-profile-schema-v1.md)
- [Build, tests and native smoke guide](docs/build-and-test.md)
- [ADR-0001: historical .NET foundation](docs/adr-0001-headless-foundation.md)
- [ADR-0002: one native shell and feature slices](docs/adr-0002-single-shell-vsa.md)
- [ADR-0003: strict profile interchange v1](docs/adr-0003-profile-interchange-v1.md)
- [Step-01 historical report](prompts/Step-01-Report.md)
- [Accepted Step-01A report](prompts/Step-01A-Report.md)
- [Step-02 worker report](prompts/Step-02-Report.md)
- [Step-02A corrective worker report](prompts/Step-02A-Report.md)
- [Orchestrator-owned roadmap](prompts/ROADMAP.md) and
[orchestration state](prompts/STATE.md)
Handoffs are manual. Step-02/Step-02A worker completion does not mean
orchestrator acceptance or authorize Step-03.