AutoForge/README.md

152 lines
6.8 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 repository and headless Core/Application foundation, accepted
2026-10-28; its original report remains historical evidence.
- Step-01A single Windows-first .NET MAUI Blazor Hybrid Client, UI and generic
Components RCLs, plus feature-oriented execution-target selection UI.
- Actual home, metadata-selection and not-found routes in the UI RCL; shared
accessible, text-safe status notices in Components.
- Immutable Simulation, RecordedReplay and PhysicalHardware target descriptors,
explicit provider/kind validation, case-insensitive exact metadata resolution,
no fallback, and DI composition in the in-process application.
- Selection and page messaging clearly state that metadata does not connect to a
vehicle or authorize any operation.
Step-01A implementation, builds, tests and a native Windows smoke run are complete.
Manual orchestrator review and acceptance are pending; no later milestone has
started. Step-02 remains held and is not authorized by this report.
### IN PROGRESS
Manual Step-01A acceptance by the orchestrator.
### PLANNED
Vehicle/module profiles, deterministic AI-independent simulation, diagnostics,
telemetry and replay, calibration and backups, and replaceable local AI with
validated runbooks require later approved assignments. Hardware integration is a
future, initially read-only boundary with separate authorization/evidence gates
for any programming. No capability is implemented merely because it appears in
the product vision or roadmap.
## Architecture
One Windows-first **AutoForge.Client** .NET 10 MAUI Blazor Hybrid executable hosts
the entire application UI via `BlazorWebView`. **AutoForge.UI** owns routing,
navigation, layouts, pages and presentation. **AutoForge.Components** owns
vehicle-independent reusable UI. Application features run in-process in a
modular monolith; the Client is the composition root. There is no backend,
browser-hosted WASM shell, Blazor Server host or second application executable.
The initial UI features are the foundation home page and explicit
execution-target metadata selection. Selection uses the existing real
Application resolver; the empty Client registration correctly shows
`ProviderNotRegistered`. No fake connected provider is installed to make the UI
look operational.
```mermaid
flowchart TD
Client[MAUI Blazor Hybrid Client] --> UI[UI RCL: routes and feature screens]
UI --> Components[Reusable Components RCL]
UI --> App[Application feature slices]
Client --> App
App --> Core[Platform-neutral Core contracts]
UnitTests[Headless unit tests] --> Components
UnitTests --> Core
IntegrationTests[Headless rendered integration tests] --> UI
IntegrationTests --> App
IntegrationTests --> Core
```
`src/AutoForge.Application/Features/ExecutionTargets/SelectExecutionTarget`
owns the explicit selection feature while its public `AutoForge.Application.ExecutionTargets`
namespace remains stable. New application behaviors should form cohesive,
independently testable feature slices. Reusable engines and domain capabilities
stay independent of the UI; add no mediator, generic repository layer or empty
future-feature projects without a concrete need.
## Repository layout
```text
AutoForge/
docs/ Technical docs and architecture decisions
prompts/ Manual assignments, state and worker evidence
src/
AutoForge.slnx
AutoForge.Client/ The sole app executable; Windows MAUI Hybrid
AutoForge.UI/ Complete routed application UI RCL
AutoForge.Components/ Generic, reusable status/notification component
AutoForge.Core/ Platform-neutral target-kind descriptors
AutoForge.Application/ Inward-dependent target-selection feature
tests/
AutoForge.UnitTests/
AutoForge.IntegrationTests/
```
## Development and prerequisites
Prerequisites for this Windows-first Client build:
- .NET SDK **10.0.402**, or a later stable patch in the same **10.0.4xx** feature
band, as pinned in [global.json](global.json).
- Installed `maui-windows` workload (10.0.110 workload manifest) and Windows SDK
target **10.0.26100.0**.
- Windows x64 runtime target and Microsoft Edge WebView2 Runtime. Native smoke
verification used WebView2 **155.0.4283.62**.
- nuget.org access for package restore.
No automotive driver, vehicle, model, backend or cloud account is required.
Other Windows, macOS, Android or iOS targets are not configured or verified.
From the repository root in PowerShell, restore and build the actual native
framework/runtime target:
```powershell
dotnet restore .\src\AutoForge.Client\AutoForge.Client.csproj --runtime win-x64
dotnet restore .\src\AutoForge.slnx
dotnet build .\src\AutoForge.Client\AutoForge.Client.csproj --configuration Release --no-restore --framework net10.0-windows10.0.26100.0
dotnet build .\src\AutoForge.slnx --configuration Release --no-restore
dotnet test .\src\tests\AutoForge.UnitTests\AutoForge.UnitTests.csproj --configuration Release --no-build
dotnet test .\src\tests\AutoForge.IntegrationTests\AutoForge.IntegrationTests.csproj --configuration Release --no-build
```
Start the application on a Windows desktop:
```powershell
dotnet run --project .\src\AutoForge.Client\AutoForge.Client.csproj --framework net10.0-windows10.0.26100.0
```
There is no backend or browser/server startup command. Headless UI/application
integration tests run independently of the native Client; they render the real
RCL components/routes and compose the actual application registration.
## Documentation and handoff
- [Documentation index](docs/README.md)
- [Current project graph and UI architecture](docs/architecture.md)
- [Original foundation ADR and its superseded decision](docs/adr-0001-headless-foundation.md)
- [Single-shell and feature-slice ADR](docs/adr-0002-single-shell-vsa.md)
- [Build, test and native smoke guide](docs/build-and-test.md)
- [Step-01 historical report](prompts/Step-01-Report.md)
- [Step-01A assignment](prompts/Step-01A.md) and
[Step-01A worker report](prompts/Step-01A-Report.md)
- [Orchestrator-owned roadmap](prompts/ROADMAP.md) and
[orchestration state](prompts/STATE.md)
Handoffs are manual. Worker completion does not mean orchestrator acceptance or
authorize the held Step-02.