gh page

Author: KSemenenko

.github/workflows/deploy-github-pages.yml

@@ -0,0 +1,69 @@
+name: Deploy GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+  release:
+    types:
+      - published
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: github-pages
+  cancel-in-progress: true
+
+env:
+  APP_PROJECT: src/PrompterLive.App/PrompterLive.App.csproj
+  PAGES_ARTIFACT_ROOT: ${{ runner.temp }}/prompterlive-pages
+  PAGES_BASE_PATH: /${{ github.event.repository.name }}/
+  PUBLISH_ROOT: ${{ runner.temp }}/prompterlive-publish
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          global-json-file: global.json
+
+      - name: Configure GitHub Pages
+        uses: actions/configure-pages@v5
+
+      - name: Publish standalone WASM app
+        run: >
+          dotnet publish
+          "$APP_PROJECT"
+          -c Release
+          -o "$PUBLISH_ROOT"
+          -p:PrompterLiveBuildNumber=${{ github.run_number }}
+
+      - name: Prepare GitHub Pages artifact
+        run: |
+          mkdir -p "$PAGES_ARTIFACT_ROOT"
+          cp -R "$PUBLISH_ROOT/wwwroot/." "$PAGES_ARTIFACT_ROOT/"
+          sed -i "s#<base href=\"/\" />#<base href=\"${PAGES_BASE_PATH}\" />#g" "$PAGES_ARTIFACT_ROOT/index.html"
+          cp "$PAGES_ARTIFACT_ROOT/index.html" "$PAGES_ARTIFACT_ROOT/404.html"
+          touch "$PAGES_ARTIFACT_ROOT/.nojekyll"
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ${{ env.PAGES_ARTIFACT_ROOT }}
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

AGENTS.md

@@ -299,6 +299,8 @@ Repo-specific design rules:
 - Repo-owned manifests, scripts, workflows, and project files that track third-party runtime JavaScript SDKs MUST point to concrete GitHub release versions and asset URLs, never floating references.
 - Any vendored runtime JavaScript SDK that tracks an upstream GitHub repo MUST have an automated watcher job that checks new GitHub releases and opens a repo issue describing the required update when a newer release appears.
 - Build quality gates must stay green under `-warnaserror`.
+- GitHub Pages is the expected CI publish target for the standalone WebAssembly app; publish automation must keep the app browser-only and Pages-compatible.
+- Version text shown in the app must come from automated build or release metadata, never from manually edited About copy.
 - The runtime must negotiate browser language from supported cultures and default to English.
 - Supported runtime cultures are English, Ukrainian, French, Spanish, Portuguese, and Italian.
 - Russian must never be added as a supported runtime culture.
@@ -342,6 +344,7 @@ Ask first:
 - backend creep in the standalone runtime
 - random-port local startup
 - brittle selectors without `data-testid`
+- mixed-language root README or public entry docs; keep them English-only unless the user explicitly asks otherwise
 - design drift from `new-design`
 - any visible typing latency in the editor; plain input must feel immediate with no observable delay
 - editor keystroke paths that persist, compile, or rebuild shared session state; keep plain typing in memory and move heavier local sync to debounce or autosave

Directory.Build.props

@@ -1,9 +1,12 @@
 <Project>
   <PropertyGroup>
     <PrompterLiveTargetFramework>net10.0</PrompterLiveTargetFramework>
-    <PrompterLiveVersionPrefix>0.1.0</PrompterLiveVersionPrefix>
+    <PrompterLiveVersionMajorMinor>0.1</PrompterLiveVersionMajorMinor>
+    <PrompterLiveBuildNumber Condition="'$(PrompterLiveBuildNumber)' == '' and '$(GITHUB_RUN_NUMBER)' != ''">$(GITHUB_RUN_NUMBER)</PrompterLiveBuildNumber>
+    <PrompterLiveBuildNumber Condition="'$(PrompterLiveBuildNumber)' == ''">0</PrompterLiveBuildNumber>
+    <PrompterLiveVersionPrefix>$(PrompterLiveVersionMajorMinor).$(PrompterLiveBuildNumber)</PrompterLiveVersionPrefix>
     <PrompterLiveAssemblyVersion>0.1.0.0</PrompterLiveAssemblyVersion>
-    <PrompterLiveFileVersion>0.1.0.0</PrompterLiveFileVersion>
+    <PrompterLiveFileVersion>$(PrompterLiveVersionPrefix).0</PrompterLiveFileVersion>
 
     <TargetFramework Condition="'$(TargetFramework)' == ''">$(PrompterLiveTargetFramework)</TargetFramework>
     <Nullable>enable</Nullable>

README.md

@@ -1 +1,209 @@
-# Teleprompter
+# PrompterLive
+
+`PrompterLive` is a browser-first teleprompter and rehearsal tool for authors, speakers, streamers, editors, and production teams.
+
+It is not a server product and not a desktop wrapper. The current runtime shape is a **standalone Blazor WebAssembly app** that boots directly in the browser, stores working state on the client, uses browser camera and microphone APIs, and can publish its WebAssembly build to GitHub Pages.
+
+## Production URL
+
+- GitHub Pages target: [https://managedcode.github.io/PrompterLive/](https://managedcode.github.io/PrompterLive/)
+- Publish workflow: [`.github/workflows/deploy-github-pages.yml`](.github/workflows/deploy-github-pages.yml)
+
+`PrompterLive` is published as a repository Pages site. After the publish workflow runs, the WebAssembly artifact is served as a static site with no separate backend.
+
+## What It Is
+
+`PrompterLive` combines several workflows into a single product:
+
+- `Library` for script and folder management
+- `Editor` for TPS authoring and speech-structure editing
+- `Learn` for RSVP rehearsal mode
+- `Teleprompter` for the classic reading surface
+- `Go Live` for browser-side live output, preview, and routing
+- `Settings` for camera, microphone, theme, and runtime preferences
+
+Architecture map: [docs/Architecture.md](docs/Architecture.md)
+
+## Key Properties
+
+- standalone Blazor WebAssembly runtime with no server backend
+- UI ported from [`new-design/`](new-design/) as the design source of truth
+- TPS-focused editor for prompt-ready scripts
+- RSVP/Learn mode with ORP-style word rendering
+- browser-side media scene, device setup, and live preview
+- Go Live runtime with LiveKit and VDO.Ninja outputs
+- browser-local document and settings storage
+- browser-realistic acceptance tests through Playwright
+
+## RSVP Inspiration
+
+`PrompterLive` does not visually copy `Squirt`, but the `Learn` mode is directly inspired by the RSVP logic and pacing approach behind Squirt-style readers.
+
+In practice that means:
+
+- ORP-style focus on a key letter inside each word
+- word timing that reacts to word length and punctuation
+- natural pauses after commas, periods, and stronger phrase boundaries
+- a custom UI and layout adapted to `PrompterLive`, not a raw Squirt clone
+
+Canonical inspiration: [cameron/squirt](https://github.com/cameron/squirt)
+
+## Technical Model
+
+- host: [`src/PrompterLive.App`](src/PrompterLive.App)
+- routed UI, CSS, browser interop: [`src/PrompterLive.Shared`](src/PrompterLive.Shared)
+- reusable domain logic: [`src/PrompterLive.Core`](src/PrompterLive.Core)
+- automated tests: [`tests/`](tests/)
+- visual reference: [`new-design/`](new-design/)
+
+Further reading:
+
+- architecture: [docs/Architecture.md](docs/Architecture.md)
+- settings media feedback: [docs/Features/SettingsMediaFeedback.md](docs/Features/SettingsMediaFeedback.md)
+- go live runtime: [docs/Features/GoLiveRuntime.md](docs/Features/GoLiveRuntime.md)
+- vendored streaming SDK policy: [docs/Features/VendoredStreamingSdkReleases.md](docs/Features/VendoredStreamingSdkReleases.md)
+- versioning and Pages publish: [docs/Features/AppVersioningAndGitHubPages.md](docs/Features/AppVersioningAndGitHubPages.md)
+
+## App Version
+
+The app version is shown in `Settings > About`.
+
+Current scheme:
+
+- local builds: `0.1.0`
+- CI builds: `0.1.<github.run_number>`
+
+Version source of truth:
+
+- [`Directory.Build.props`](Directory.Build.props)
+- [`src/PrompterLive.App/Program.cs`](src/PrompterLive.App/Program.cs)
+
+Versioning and Pages workflow details: [docs/Features/AppVersioningAndGitHubPages.md](docs/Features/AppVersioningAndGitHubPages.md)
+
+## Local Run
+
+Requirements:
+
+- [.NET 10 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/10.0)
+
+Run:
+
+```bash
+cd src/PrompterLive.App
+dotnet run
+```
+
+Useful commands:
+
+```bash
+dotnet build /Users/ksemenenko/Developer/PrompterLive/PrompterLive.slnx -warnaserror
+dotnet test /Users/ksemenenko/Developer/PrompterLive/PrompterLive.slnx
+dotnet format /Users/ksemenenko/Developer/PrompterLive/PrompterLive.slnx
+dotnet test /Users/ksemenenko/Developer/PrompterLive/PrompterLive.slnx --collect:"XPlat Code Coverage"
+```
+
+## Deploy
+
+Publish runs through the GitHub Actions workflow:
+
+- [`.github/workflows/deploy-github-pages.yml`](.github/workflows/deploy-github-pages.yml)
+
+What it does:
+
+- builds `src/PrompterLive.App`
+- injects the CI build number into the app version
+- takes the published `wwwroot`
+- rewrites `base href` for the repository Pages path
+- adds `404.html` for client-side routing
+- deploys the artifact to GitHub Pages
+
+Official platform reference: [GitHub Pages](https://docs.github.com/en/pages)
+
+## Stack
+
+- [.NET 10](https://dotnet.microsoft.com/en-us/download/dotnet/10.0)
+- [Blazor](https://dotnet.microsoft.com/en-us/apps/aspnet/web-apps/blazor)
+- Razor Class Library
+- [xUnit](https://xunit.net/)
+- [bUnit](https://bunit.dev/)
+- [Playwright](https://playwright.dev/)
+
+## Browser Media And Streaming Stack
+
+`PrompterLive` is a browser-first media app, so it relies on standard Web APIs and a thin interop layer:
+
+- [WebRTC API](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API)
+- [`getUserMedia()`](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia)
+- [MediaRecorder](https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder)
+- [Web Audio API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API)
+
+Integrated streaming and media projects:
+
+- [LiveKit](https://livekit.com/)  
+  docs: [Connecting to LiveKit](https://docs.livekit.io/intro/basics/connect/)  
+  repo: [livekit/client-sdk-js](https://github.com/livekit/client-sdk-js)
+- [VDO.Ninja](https://vdo.ninja/)  
+  repo: [steveseguin/vdo.ninja](https://github.com/steveseguin/vdo.ninja)
+
+Pinned vendored SDK policy and version tracking:
+
+- [docs/Features/VendoredStreamingSdkReleases.md](docs/Features/VendoredStreamingSdkReleases.md)
+
+Currently pinned in the repository:
+
+- `livekit/client-sdk-js` `v2.18.0`
+- `steveseguin/vdo.ninja` `v29.0`
+
+## Fonts, Icons, And Visual Sources
+
+- [Inter](https://rsms.me/inter/)
+- [JetBrains Mono](https://www.jetbrains.com/lp/mono/)
+- [Playfair Display](https://fonts.google.com/specimen/Playfair+Display)
+- [Google Fonts](https://fonts.google.com/)
+- [Feather Icons](https://feathericons.com/)
+
+## Credits And Inspirations
+
+These are the external projects, APIs, and references that `PrompterLive` builds on:
+
+### Platform And Runtime
+
+- [.NET 10](https://dotnet.microsoft.com/en-us/download/dotnet/10.0)
+- [Blazor](https://dotnet.microsoft.com/en-us/apps/aspnet/web-apps/blazor)
+- [GitHub Pages](https://docs.github.com/en/pages)
+
+### Test Infrastructure
+
+- [xUnit](https://xunit.net/)
+- [bUnit](https://bunit.dev/)
+- [Playwright](https://playwright.dev/)
+
+### Browser Media And Streaming
+
+- [LiveKit](https://livekit.com/)
+- [LiveKit connection docs](https://docs.livekit.io/intro/basics/connect/)
+- [livekit/client-sdk-js](https://github.com/livekit/client-sdk-js)
+- [VDO.Ninja](https://vdo.ninja/)
+- [steveseguin/vdo.ninja](https://github.com/steveseguin/vdo.ninja)
+- [WebRTC API](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API)
+- [`getUserMedia()`](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia)
+- [MediaRecorder](https://developer.mozilla.org/en-US/docs/Web/API/MediaRecorder)
+- [Web Audio API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API)
+
+### RSVP And Speed-Reading Inspiration
+
+- [cameron/squirt](https://github.com/cameron/squirt)
+
+### Typography And Icons
+
+- [Inter](https://rsms.me/inter/)
+- [JetBrains Mono](https://www.jetbrains.com/lp/mono/)
+- [Playfair Display](https://fonts.google.com/specimen/Playfair+Display)
+- [Google Fonts](https://fonts.google.com/)
+- [Feather Icons](https://feathericons.com/)
+
+If we missed someone in the credits, open an issue or PR and add the attribution explicitly instead of leaving the dependency implicit.
+
+## License
+
+This project is licensed under [MIT](LICENSE).

docs/Architecture.md

@@ -109,6 +109,7 @@ flowchart LR
 - `Directory.Packages.props` is the canonical source for NuGet package versions.
 - `Directory.Build.props` is the canonical source for shared target framework, analyzer policy, and assembly/app version settings.
 - `global.json` pins the expected .NET SDK for local and CI builds.
+- `.github/workflows/deploy-github-pages.yml` is the canonical GitHub Pages publish flow for the standalone WASM app, including CI run-number version injection and Pages artifact base-href rewriting.
 - Vendored browser SDK release pins live in `vendored-streaming-sdks.json`, and the exact release sync or watch flow is documented in `docs/Features/VendoredStreamingSdkReleases.md`.
 
 ## Runtime Boundaries

docs/Features/AppVersioningAndGitHubPages.md

@@ -0,0 +1,54 @@
+# App Versioning And GitHub Pages
+
+## Scope
+
+`PrompterLive` exposes the running app version inside the Settings About screen and publishes the standalone WebAssembly build to GitHub Pages.
+
+This flow keeps the version number automated:
+
+- local builds default to `0.1.0`
+- CI builds derive `0.1.<run_number>` from the active GitHub Actions run
+- the About screen reads the compiled assembly metadata instead of hardcoded copy
+
+## Version And Deploy Flow
+
+```mermaid
+flowchart LR
+    Run["GitHub Actions run_number<br/>or local default 0"]
+    BuildProps["Directory.Build.props<br/>Version = 0.1.build"]
+    Assembly["PrompterLive.App assembly metadata"]
+    Program["Program.cs<br/>IAppVersionProvider"]
+    About["Settings About card"]
+    Publish["dotnet publish"]
+    PagesPrep["deploy-github-pages.yml<br/>rewrite base href + copy 404.html"]
+    Pages["GitHub Pages"]
+
+    Run --> BuildProps
+    BuildProps --> Assembly
+    Assembly --> Program
+    Program --> About
+    BuildProps --> Publish
+    Publish --> PagesPrep
+    PagesPrep --> Pages
+```
+
+## Source Of Truth
+
+- `Directory.Build.props` is the only source of app version composition.
+- `PrompterLiveBuildNumber` comes from `GITHUB_RUN_NUMBER` when CI provides it, or falls back to `0` locally.
+- `Program.cs` creates `IAppVersionProvider` from the compiled `PrompterLive.App` assembly metadata.
+- `SettingsAboutSection` renders that provider value in the About card subtitle.
+
+## GitHub Pages Rules
+
+- GitHub Pages publishes the standalone `src/PrompterLive.App` artifact only.
+- The workflow copies the published `wwwroot` output, not the host wrapper files around it.
+- The workflow rewrites `<base href="/">` to `/<repo-name>/` only inside the Pages artifact.
+- The workflow copies `index.html` to `404.html` so client-side routes keep working on repository Pages hosting.
+- `.nojekyll` must be present in the Pages artifact so framework and `_content` assets are served as-is.
+
+## Verification
+
+- `dotnet test /Users/ksemenenko/Developer/PrompterLive/tests/PrompterLive.App.Tests/PrompterLive.App.Tests.csproj --filter "FullyQualifiedName~SettingsInteractionTests.AboutSection_RendersInjectedAppVersionMetadata"`
+- `dotnet test /Users/ksemenenko/Developer/PrompterLive/tests/PrompterLive.App.UITests/PrompterLive.App.UITests.csproj --filter "FullyQualifiedName~TeleprompterSettingsFlowTests.TeleprompterAndSettingsScreens_RespondToCoreControls"`
+- `.github/workflows/deploy-github-pages.yml` publish step passes `-p:PrompterLiveBuildNumber=${{ github.run_number }}`

src/PrompterLive.App/Program.cs

@@ -4,6 +4,7 @@
 using PrompterLive.App;
 using PrompterLive.App.Services;
 using PrompterLive.Shared.Services;
+using PrompterLive.Shared.Settings.Services;
 
 var builder = WebAssemblyHostBuilder.CreateDefault(args);
 
@@ -17,6 +18,7 @@
 
 builder.Services.AddLocalization();
 builder.Services.AddSingleton<IFormFactor, FormFactor>();
+builder.Services.AddSingleton<IAppVersionProvider>(_ => AppVersionProviderFactory.CreateFromAssembly(typeof(Program).Assembly));
 builder.Services.AddPrompterLiveShared();
 
 var host = builder.Build();