docs: convert screenshot placeholders to constrained table layout
Replace freeform blockquote placeholders with two-column tables
(description | image) matching the original layout. Tables keep
images at a consistent size and prevent layout shift regardless
of screenshot dimensions.
New WebFrontendWeatherPage.png placeholder added to walkthrough table.
All existing asset filenames preserved so old shots still render.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
fix: replace \n with <br/> in Mermaid flowchart node labels
\n is not rendered as a newline in GitHub's Mermaid — use <br/> instead.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
docs: add Mermaid architecture and request flow diagrams to Sample-Application.md
- Architecture flowchart showing project structure, service dependencies,
and HTTP connections between AppHost, APIService, Web, Scalar, ServiceDefaults, Shared
- Sequence diagram (happy path): full two-hop telemetry flow from user click
through IWeatherAPIClientTelemetry -> HTTP -> IWeatherServiceTelemetry
- Sequence diagram (error paths): validation failure (422) and simulated
upstream failure (502) paths with all telemetry calls annotated
- Replace ASCII art pseudo-code blocks with the diagrams
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
docs: overhaul Sample-Application.md with correct code flow and screenshot placeholders
- Clarify IEntityStoreTelemetry is a standalone demo, not wired to HTTP endpoints
- Complete IWeatherServiceTelemetry interface (add FailedToRetrieveForecast, TemperaturesReceived, TemperaturesWithinRange)
- Complete IWeatherAPIClientTelemetry interface (add RequestComplete, RequestSuccess, NoForecastsRecieved)
- Add Request Flow section showing two-hop telemetry (Blazor -> API)
- Update unit test example: TUnit + NSubstitute with real assertion patterns
- Fix generated file paths (add Services. namespace prefix, list both projects)
- Replace all screenshot image references with descriptive 📸 placeholders
- Add new placeholder for Blazor frontend Weather page (new screenshot needed)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
docs: rewrite Sample-Application.md and Generated-Output.md
Sample-Application.md:
- Document full 6-project structure (AppHost, APIService, Web, Shared, ServiceDefaults, UnitTests)
- Add all three telemetry interfaces with code snippets (IEntityStoreTelemetry, IWeatherServiceTelemetry, IWeatherAPIClientTelemetry)
- Fix Scalar access: now a separate Aspire resource, not the api-service endpoint
- Add NSubstitute unit test mocking example
- Add Generated Code section with correct obj/ path
- Link to Generated-Output wiki page
Generated-Output.md:
- Replace placeholder with full annotated real-world generated code examples
- Input interface definition (IEntityStoreTelemetry)
- Activity, Logging, Metrics, multi-target orchestration, DI extension, TelemetryNames sections
- Each section includes inline notes explaining generated patterns
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
docs: overhaul wiki — add Performance page, fix API docs, update generated output examples
- Add Performance.md with full cross-runtime BenchmarkDotNet results (moved from PERFORMANCE.md)
- Update Generated-Output.md with real generated code from IEntityStoreTelemetry sample
- Fix Logging.md, Logging-Generation-v1.md, Logging-Generation-v2.md:
* Replace removed DisableMSLoggingTelemetryGeneration bool with GenerationMode: LoggerGenerationMode
* Add undocumented GenerationMode to LogAttribute table
* Add undocumented DefaultPrefixType to LoggerGenerationAttribute table
- Fix Sample-Application.md: correct project name Sample.AppHost -> SampleApp.AppHost
- Fix Quick-Start.md: typo in generated filename, fix broken API Reference link
- Add Performance page link to Home.md reference section
- Update all version strings to 4.0.0-prerelease.6 (Breaking-Changes, FAQ, Getting-Started, Installation, Quick-Start)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
docs: added a page for the sample app, and fixed .md file references