Compare commits

...
Author SHA1 Message Date
poli0981andClaude Opus 5.5 0cce0ac0ce feat: the accessibility statement - ACCESSIBILITY.md under Help > Accessibility and on the wiki, the Accessibility problem form and its label, the documents corrected (D88) (beta.35 PR-1)
ACCESSIBILITY.md states WCAG 2.2 AA through WCAG2ICT as a goal and never a claim, what works with the keyboard
alone, a screen reader, a contrast theme or Magnifier, how it is checked (the owner's pass of 2026-11-09 on
beta.34 and alpha.3), the known limits with what to do instead, and how a barrier is reported and handled - by
severity, no promised times. Embedded and shown under Help > Accessibility and after Limitations in the guide's
window; a wiki page of its own.

The Accessibility problem issue form, a user-interface section in the PR template, and the labels accessibility,
safety and priority-high - the last two named by the Safety gap form since 2026-08-02 and never existing.

Documents corrected: charts take focus and ScottPlot's keys (ChartKeyboardTests measures it; 08_UI said
neither); the database-maintenance live region announces nothing; the Narrator gap is the owner's pass now;
20_OPEN_QUESTIONS G's accessibility row closed; NFR-9 widened (D88-D91); LIMITATIONS gains an Accessibility
section and loses its one struck sentence, which a screen reader reads as current.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 10:39:34 +07:00
43 changed files with 737 additions and 65 deletions

No files matched your search

+100
View File
@@ -0,0 +1,100 @@
# ACCESSIBILITY.md (beta.35, D88) sends every accessibility barrier here. It is its own form rather than part of the bug
# report because a barrier needs different facts: what the reporter uses to read or operate the screen, and how far it
# stops them. Nothing here asks about the reporter themself.
name: Accessibility problem
description: Something in FrameLedger cannot be reached, read or seen — with the keyboard, a screen reader, a contrast theme, Magnifier or another aid
labels: [accessibility]
body:
- type: markdown
attributes:
value: |
Thank you for telling us. **You never need to tell us anything about yourself or a disability** — what you use
and what happened is enough. Screenshots and recordings help but are optional.
If FrameLedger refused to hook a game, stopped measuring or turned hooking off **without your knowing** — a
safety notice you could not perceive — say so below: it is a safety problem too, and it is handled first.
What FrameLedger aims for and what it cannot do yet: [ACCESSIBILITY.md](https://github.com/poli0981/frameledger/blob/main/ACCESSIBILITY.md).
- type: textarea
id: task
attributes:
label: What were you trying to do?
placeholder: 'e.g. switch hooking on for a game, read a session''s frame rate, answer the terms window'
validations:
required: true
- type: textarea
id: what-happened
attributes:
label: What happened instead?
description: What you heard, saw or could not do — and what you expected.
validations:
required: true
- type: textarea
id: steps
attributes:
label: How to get there
placeholder: |
1. Open Games (Ctrl+2)
2. Tab to …
3. …
- type: input
id: app-version
attributes:
label: FrameLedger version
description: Help ▸ About
validations:
required: true
- type: input
id: os
attributes:
label: Windows version
placeholder: 'Windows 11 26100.2314'
validations:
required: true
- type: dropdown
id: aid
attributes:
label: What do you use?
multiple: true
options:
- Keyboard only
- Narrator
- NVDA
- JAWS
- Windows Magnifier
- A Windows contrast theme
- Voice Access or other speech input
- Display scaling or a large text size
- Something else (say below)
validations:
required: true
- type: input
id: aid-version
attributes:
label: Its version, if you know it
placeholder: 'e.g. NVDA 2026.1'
- type: dropdown
id: severity
attributes:
label: How much does it stop you?
description: Optional — the maintainer sets it when reading the report (ACCESSIBILITY.md, How serious it is).
options:
- Not sure
- Critical — I cannot do the task at all
- Serious — only with great difficulty or a workaround
- Moderate — it is tiring or inconsistent
- Minor — it barely gets in the way
- type: textarea
id: more
attributes:
label: Anything else
description: A screenshot, a recording, or a diagnostic file from Help ▸ Report a bug (built on your PC; you choose what to attach).
+12
View File
@@ -30,6 +30,18 @@ review questions from `docs/19_SAFETY_AND_ANTICHEAT.md` §Review checklist.
**Measured overhead:** <!-- e.g. "0.31 µs/present, game Avg FPS delta -0.2%" -->
## User-interface changes only
Skip this section if the PR does not change what the App shows. Otherwise — `ACCESSIBILITY.md` §For contributors,
`docs/08_UI.md` §Accessibility:
- [ ] Every control that shows no text of its own has a name, from `.resx` in `en`, `vi` and `ja`
- [ ] Colours come from the theme only, and nothing is shown by colour alone
- [ ] Everything new can be reached and used with the keyboard, in reading order, and Esc leaves a new dialog
- [ ] `ACCESSIBILITY.md` (and `LIMITATIONS.md`) changed in this PR if what works or what does not moved
**Checked by hand:** <!-- e.g. "Tab through the new card with the mouse unplugged; Narrator reads its name and value" -->
## Safety-string changes only
- [ ] `Safety_*` resx keys have human-reviewed `ja` (never machine-drafted — `docs/09_I18N.md`)
+1 -1
View File
@@ -1,5 +1,5 @@
# The GitHub Wiki is a copy of the repository's own pages (D53/D54, the owner, 2026-10-07): wiki/ (Home, the sidebar,
# the developer pages) and guide/ (the user guide, which is the End-user part) with LIMITATIONS.md, assembled and checked
# the developer pages) and guide/ (the user guide, which is the End-user part) with LIMITATIONS.md and ACCESSIBILITY.md, assembled and checked
# by tools/wiki-build.ps1 - the check build.ps1 runs as `wiki-check`. A page edited on the Wiki tab is overwritten here;
# edit wiki/ or guide/ instead (docs/13_CI_CD.md §wiki.yml).
#
+145
View File
@@ -0,0 +1,145 @@
# Accessibility
FrameLedger should be usable by everyone who plays games on a Windows PC — with a keyboard alone, with a screen reader,
with a Windows contrast theme or Magnifier, and without telling colours apart. This page says what FrameLedger aims
for, what works today, how that was checked, what does not work yet and what to do instead, and how to tell us about a
barrier. It is written for the person who has just met one; the details for developers are in
[`docs/08_UI.md`](docs/08_UI.md#accessibility).
FrameLedger is a desktop program: its own window, its dialogs, its document windows, the icon by the clock and the
notices Windows shows for it. It draws nothing inside a game, so it cannot make a game itself any easier to use.
*Beta software: this page describes version 0.1.0-beta.35. In the app: Help ▸ Accessibility.*
## What FrameLedger aims for
- **WCAG 2.2 at level AA**, applied to desktop software as W3C's
[WCAG2ICT](https://www.w3.org/TR/wcag2ict-22/) guidance explains. This is a goal that guides the work, not a claim:
no formal evaluation has been made, and FrameLedger does not say it conforms to any standard.
- **Every task can be done with the keyboard alone.**
- **A screen reader can read every control and every value**, in the language FrameLedger is shown in, and hears what
changes — a notice, a result.
- **Text and controls keep their contrast** in the light and the dark theme and under Windows contrast themes, and
**colour is never the only way something is shown.**
- **Everything stays sharp at any display scale**, and when the window moves between screens.
## What works today
### The keyboard
| Keys | What they do |
|---|---|
| **Ctrl+1** … **Ctrl+5** (also with the numeric keypad) | Open Dashboard, Games, Compare, Logs and Settings. |
| **Alt** or **F10**, then the arrow keys and **Enter** | Move to the menus. **Alt** with a menu's underlined letter opens it (*File*, *Tools*, *Help* in English). |
| **Tab** and **Shift+Tab** | Move through a page or a dialog in reading order. |
| The **arrow keys**, **Home**, **End**, **Page Up**, **Page Down** | Move inside a list or a table — a game's sessions, the games list, the Compare list, the import checklist. |
| **Enter** or **Space** | Press the button, switch or box that has the focus. **Enter** on a game in the list opens its page. |
| **Esc** | Closes a dialog the way its **Close** or **Cancel** button does: nothing is changed. A dialog that has no Close button waits for an answer, and the terms window has its own **Decline** and **Accept**. |
| **Enter** in the hooking warning | Switches hooking on once the phrase is typed exactly; before that it does nothing. |
The same keys are in the user guide, [The screens](guide/07-screens.md#keyboard-and-mouse).
### Screen readers
- **Every page, menu, dialog and setting can be reached and used with Narrator.** The owner checked this on
2026-11-09, keyboard only with the mouse disconnected, on 0.1.0-beta.34 and 0.1.0-alpha.3, and found no fault.
- **Every button, switch and box that shows no text of its own has a name**, from the same translations as the screen.
- **Dialogs say they are dialogs** and keep the focus inside them until they close.
### Seeing the screen
- **Light, dark, or the same as Windows** (Settings ▸ Theme). FrameLedger takes every colour from the theme, and every
text is measured against what is painted under it, in both themes.
- **The colour a game's picture lends its page** is used only as far as every text on it still reads, and never under a
contrast theme.
- **Windows display scaling** at any size, on every screen; **Magnifier** (Windows logo key + Plus) works as with any
program.
- Labels such as *Hooking on* and *Not installed*, and the ray-tracing chips, always carry their words; a chip that reads
*N/A* is also drawn with a dashed edge.
### Languages
FrameLedger is shown in English, Vietnamese or Japanese (Settings ▸ Language), and the names a screen reader reads come
from the same translations. The documents — the user guide, this page, the legal texts — are in English.
## How it is checked
- **On every build**, by the project's own tests: every control that shows no text has a name; no colour is written
into a screen; every text reads against its background in both themes and after a theme switch; **Esc** closes the
open dialog without an answer; **Ctrl+1** … **Ctrl+5** open the pages in their order; the program declares it follows
each screen's scaling.
- **By hand**: the owner's pass of 2026-11-09 above, repeated for each release that changes a screen.
- **Not tested yet**: NVDA, JAWS, Voice Access, touch, Windows 10, and other people's PCs. They should work through the
same Windows interface Narrator uses, but nobody has checked.
## Known limitations
Each one with what to do instead. A barrier that is not on this list is worth reporting.
- **Charts are pictures.** Tab reaches a chart, but its keys do not work reliably yet and a screen reader cannot read
its points or its name. The numbers are written out elsewhere: a session's figures and *Statistics per series* in its
summary, the table under the Compare chart, the list of changes under a trend chart, and **File ▸ Export ▸ Session
CSV** or **Session JSON**.
- **Some names a screen reader hears are wrong.** Items in drop-down lists and several lists can be read by an
internal name rather than the text shown; the frame-rate readout, the ray-tracing chips and the text of the notices
above the page are not read as text; some buttons in a list all have the same name, such as *Open*.
- **Nothing is announced when it appears** — a safety notice, a banner, a short message at the bottom of the window or
the result of **Tools ▸ Database maintenance**. A safety notice stays above the page until you answer it.
- **Headings are not marked as headings**, so a screen reader's heading keys do not move between the sections of a
page.
- **Windows contrast themes are not followed.** With Settings ▸ Theme on *System*, a contrast theme can give parts of
the window the wrong colours. Choose **Light** or **Dark** there: both keep their contrast.
- **The short messages at the bottom of the window close after four seconds.**
- **Windows' text size setting** (Settings ▸ Accessibility ▸ Text size) **is not followed.** Use display scaling
(Settings ▸ System ▸ Display ▸ Scale) or Magnifier.
- **Page changes slide in** even when Windows' animation effects are off.
- **Pausing capture is only in the menu of the icon by the clock.**
- **The windows Windows itself shows** — choosing a file, the administrator prompt — are Windows', not FrameLedger's.
## Report an accessibility problem
1. Open an issue with the
[Accessibility problem form](https://github.com/poli0981/frameledger/issues/new?template=accessibility.yml).
2. Say what you were trying to do and what happened instead; your FrameLedger version (Help ▸ About) and your Windows
version; and what you use — the keyboard alone, Narrator, NVDA, JAWS, Magnifier, a contrast theme — with its version.
The steps to get there help, and so does a screenshot or a recording, but neither is required. **You never need to
tell us anything about yourself or a disability.**
3. If you want to attach details from your PC, **Help ▸ Report a bug** builds them into a file on your PC and shows you
what is inside first; nothing is uploaded by itself.
**A safety notice you could not perceive** — hooking refused, measuring stopped or hooking turned off, without your
knowing — is a safety problem as well: say so in the report, and it is handled first.
### How serious it is
You do not have to choose; the maintainer sets it when reading the report.
| Severity | What it means | For example |
|---|---|---|
| **Critical** | A task cannot be done at all. | Hooking cannot be switched off with the keyboard; the terms window or the hooking warning cannot be answered; a safety notice cannot be read. |
| **Serious** | It can be done only with great difficulty or a workaround. | A value can be read only by exporting the session. |
| **Moderate** | It is tiring or inconsistent. | A name that differs from what the screen shows; an extra stop for Tab. |
| **Minor** | It barely gets in the way. | A tooltip the keyboard cannot reach, when its words are shown elsewhere too. |
### What happens next
FrameLedger has one maintainer, so there are no promised times. Every report is read and answered, without doubting what
you describe. Critical problems come before other work; a workaround, when there is one, is written on the issue; the
fix ships in a release, and the issue is closed once you say it works for you — or when a fix has been out for a while
and nobody has answered.
## Who looks after this
The project's owner, poli0981, keeps this page and the checks behind it, and reviews both for each release that changes
a screen. A change to FrameLedger that moves anything on this page changes the page in the same pull request.
## For contributors
A change to the App keeps what the tests above hold: a name, from the translations in all three languages, for every
control that shows no text; colours only from the theme. Say in the pull request what you checked with the keyboard
and with Narrator. The rules and the checks are in [`docs/08_UI.md`](docs/08_UI.md#accessibility) and
[`CONTRIBUTING.md`](CONTRIBUTING.md).
## Feedback
To improve this page, open an issue or a pull request. A barrier goes through the form above, so that it is not lost.
+23
View File
@@ -35,6 +35,29 @@ numeric core and does not move; the heading is the full version — corrected 20
## [Unreleased]
### Added
- **An accessibility statement** (owner request 2026-11-09, decision D88). `ACCESSIBILITY.md` says what FrameLedger aims
for — WCAG 2.2 at level AA as W3C's WCAG2ICT applies it to desktop software, a goal and not a claim of conformance —
what works with the keyboard alone, a screen reader, a contrast theme or Magnifier, how it is checked (the project's
tests, and the owner's pass of 2026-11-09: keyboard only and Narrator on 0.1.0-beta.34 and 0.1.0-alpha.3, no fault),
what does not work yet and what to do instead, and how a barrier is reported and handled — by severity, with no
promised times. The app shows it under **Help ▸ Accessibility**, and after Limitations in the user guide's window; the
wiki gets an *Accessibility* page.
- **An *Accessibility problem* issue form** (`.github/ISSUE_TEMPLATE/accessibility.yml`) asking what was tried, what
happened and what the reporter uses — never anything about the reporter themself — and a user-interface section in the
pull-request template. The `accessibility` label exists, and so do `safety` and `priority-high`, which the *Safety gap*
form had named since its first day without either existing — so GitHub had never applied them.
### Changed
- **Documents corrected**: charts do take focus and keys (`docs/08_UI.md` said neither — `ChartKeyboardTests` measures
it); the database-maintenance result's live region announced nothing, since WPF raises one only when the app does; the
"no Narrator pass" gap is the owner's pass now, beside what that pass could not show; the open question "Accessibility
/ DPI: no design anywhere" is closed; NFR-9 names screen readers and contrast themes (D88–D91). `LIMITATIONS.md` gains an
*Accessibility* section and loses its one struck sentence — a screen reader reads struck text as current, so no page
the app shows strikes text through. The guide's menu table names its menu on every row, read one row at a time.
## Releases
Newest first. Each file holds that release's section exactly as it stood here.
+9 -3
View File
@@ -49,7 +49,7 @@ A C++ DLL (`FrameLedger.Overlay.dll`) is injected into games the user explicitly
| UI | WPF + WPF UI (`WPF-UI` pinned = 4.3.0) + CommunityToolkit.Mvvm — `docs/16_WPFUI_SYNTAX.md` |
| App composition | .NET Generic Host + DI in `FrameLedger.App` |
| Charts | ScottPlot 5 |
| Markdown in the App | **Markdig** (BSD-2-Clause, pinned ~~1.4.0~~ 1.5.0 since beta.31 — 1.4.2 in beta.30) → WPF `FlowDocument`, HTML off, no image fetched — the Legal Gate, the user guide, Help ▸ Limitations, the update notes, About (beta.12; row added 2026-10-04) |
| Markdown in the App | **Markdig** (BSD-2-Clause, pinned ~~1.4.0~~ 1.5.0 since beta.31 — 1.4.2 in beta.30) → WPF `FlowDocument`, HTML off, no image fetched — the Legal Gate, the user guide, Help ▸ Limitations, Help ▸ Accessibility (beta.35, D88), the update notes, About (beta.12; row added 2026-10-04) |
| GPU telemetry | **The game process's own memory since beta.12 (D43):** `FrameLedger.ProcessStats.dll` (C++, loaded by the Agent, never into a game) reads its dedicated/shared GPU memory from the `GPU Process Memory` counters and its working sets from `GetProcessMemoryInfo` — `18_GPU_VENDOR_APIS` §The game process's memory. Layered: DXGI + PDH counters (all vendors) → LibreHardwareMonitorLib (MPL-2.0, all vendors) → **NVAPI (MIT, headers + `amd64/nvapi64.lib` vendored 2026-08-05** at `src/native/third_party/nvapi/`, consumed via the `fl_nvapi` target; NVIDIA extras + Reflex). **No AMD/Intel vendor SDK** — `docs/18_GPU_VENDOR_APIS.md`. ~~**No telemetry source exists in code yet**~~ **`LhmTelemetrySource` (L2) exists since 2026-09-03 (`20_OPEN_QUESTIONS` §M5 row R1, eight GPU fields unelevated); L1 (`BaselineTelemetrySource`: DXGI identity + the PDH adapter-memory counter, the first CsWin32 consumer), `CompositeTelemetrySource` and the 1 Hz `TelemetryPoller` since 2026-09-09; L3 (`NvapiTelemetrySource` over the native `FrameLedger.NvapiBridge.dll` — the only shipped binary linking `nvapi64.lib`, loaded by the Agent into its own process and never into a game) since 2026-09-10 (PR-E2)** — `ctest fl_nvapi_probe` was the only NVAPI consumer until then, and it exists so the vendoring is verified rather than asserted. This row said no source existed for six days after one did, recorded 2026-09-09 rather than repaired quietly. This row previously claimed the vendoring in the present tense while `third_party/` held only `vulkan-headers`; `legal/` had already caught the identical claim about itself and gained a bidirectional gate, which is what made the real vendoring a red-then-green |
| CPU/board sensors | LibreHardwareMonitorLib ≥ 0.9.6 (PawnIO) — **optional**, elevated only |
| Tier-2 fallback | **There is none, and Tier 2 is not a measurement.** Owner decision 2026-08-28: the ladder is two rungs — hooked, or duration + sensors + the reason. ~~ETW-based, no injection~~; ~~Intel PresentMon console binary~~ dropped 2026-08-27 after §S31 retired it. Whether a shipped build ever regains a no-injection measurement is `docs/20_OPEN_QUESTIONS.md` §G |
@@ -67,6 +67,7 @@ A C++ DLL (`FrameLedger.Overlay.dll`) is injected into games the user explicitly
FrameLedger.slnx # XML solution format (SDK default since .NET 10)
NOTICE # copyright + the GPLv3 section 7 additional terms (beta.12, D45)
CONTRIBUTING.md FORKING.md CODE_OF_CONDUCT.md # for people who build, contribute or redistribute
LIMITATIONS.md ACCESSIBILITY.md # what the software cannot do; the accessibility statement (D36, D88)
global.json # pins the SDK band — see 12_BUILD
RELEASE_LINE # `main`, or `alpha` on the alpha branch (D73, 2026-10-31) — 12_BUILD §The alpha line
build.ps1 # the quality gate; CI runs this identical script
@@ -165,7 +166,7 @@ guide/ # the user guide (beta.12, D44): ~~eight~~ short
# (twelve since beta.17, D54: the screens, every setting, troubleshooting, a glossary;
# and the guide is the wiki's End-user part)
wiki/ # the wiki's own pages (beta.17, D53): Home, _Sidebar, the developer pages. wiki.yml
# publishes them with guide/ and LIMITATIONS.md to the Wiki tab at a release;
# publishes them with guide/, LIMITATIONS.md and ACCESSIBILITY.md to the Wiki tab at a release;
# tools/wiki-build.ps1 assembles and checks them (build.ps1 wiki-check)
docs/ legal/ legal/licenses/
```
@@ -196,6 +197,8 @@ The version handshake is wired end to end as of 2026-08-05: `FlGuardBuildId` giv
- Hook-path changes state measured overhead in the PR body (`14_TESTING` §Hook overhead).
- Any new hook is listed in `17_HOOK_ENGINE` §Hook inventory and justified against rule 4.
- New user-visible strings exist in `en`, `vi`, `ja`.
- A change to what the App shows keeps `ACCESSIBILITY.md` §For contributors (names, theme colours, nothing by colour alone,
keyboard reach) and updates that page when it moves what works or what does not (D88).
- Any deviation from a doc updates that doc in the same PR.
## Reading order
@@ -219,7 +222,10 @@ The version handshake is wired end to end as of 2026-08-05: `FlGuardBuildId` giv
10. Remaining (`09`–`15`).
11. **`LIMITATIONS.md`** (repository root; shown in the App under Help ▸ Limitations) — what the WHOLE software cannot
do, in the user's words, each item linked to its details. When a change moves a limit, the page changes in the same
PR (D36, 2026-09-27). **`docs/LIST_GAME_TESTED.md`** — the real games FrameLedger has been run with and what each
PR (D36, 2026-09-27). **`ACCESSIBILITY.md`** (repository root; Help ▸ Accessibility) — the accessibility statement:
WCAG 2.2 AA through WCAG2ICT as a goal, never a claim; what works with the keyboard, a screen reader and contrast
themes, what does not, how a barrier is reported (D88, 2026-11-09); `docs/08_UI.md` §Accessibility holds its checks.
**`docs/LIST_GAME_TESTED.md`** — the real games FrameLedger has been run with and what each
session measured, from a copy of the owner's ledger and the repository's own evidence (D35).
**Before writing native or capture code, read `docs/20_OPEN_QUESTIONS.md`** (its open entries; since beta.24 the
+7 -1
View File
@@ -11,6 +11,8 @@ merged, and under what licence your contribution is accepted.
- **Open an issue before anything larger than a fix**, so the approach can be agreed before the work is done.
- **A game with anti-cheat that FrameLedger fails to detect** is a safety bug: use the *Safety gap* issue form.
- **A vulnerability in FrameLedger itself** goes the private route in `SECURITY.md`, never a public issue.
- **Something that cannot be reached, read or seen** — with the keyboard, a screen reader, a contrast theme — uses the
*Accessibility problem* form; `ACCESSIBILITY.md` says what the App aims for.
- Everyone who takes part follows the `CODE_OF_CONDUCT.md`.
## Building
@@ -45,13 +47,17 @@ The definition of done is the one in `CLAUDE.md`:
- a change to the hook path states its measured overhead in the PR (`docs/14_TESTING.md` §Hook overhead);
- a new hook is listed in `docs/17_HOOK_ENGINE.md` §Hook inventory and justified against rule 4;
- every new user-visible string exists in `en`, `vi` and `ja` (`docs/09_I18N.md`);
- a change to what the App shows keeps `ACCESSIBILITY.md` §For contributors — a name for every control that shows no
text, theme colours only, nothing shown by colour alone, everything reachable by keyboard — and says in the PR what was
checked with the keyboard and Narrator; if it moves what works or what does not, `ACCESSIBILITY.md` changes with it;
- a change that makes a document wrong updates that document in the same PR;
- a change under `src/` adds an entry under `## [Unreleased]` in `CHANGELOG.md`;
- every new source file carries the licence header — `./tools/notice-check.ps1 -Fix` writes it. A file you wrote
yourself may name you in its second line instead, in the same form:
`Copyright (C) <year> <your name> - additional terms under GPLv3 section 7: see NOTICE`.
The pull-request template lists the safety checks for changes to the capture layer.
The pull-request template lists the safety checks for changes to the capture layer, and the accessibility checks for
changes to the user interface.
## What will not be merged
+11 -1
View File
@@ -109,7 +109,7 @@ shown is recorded too, from outside the game. ([Capture](docs/04_CAPTURE.md))
DLSS 4), the NVIDIA App's *Dynamic* frame generation that the driver reports applied (DLSS 4.5, whatever multiplier
it chose — since 0.1.0-beta.34), or a library whose major version names one (2.x, 3.x). A *Fixed* ×5 or ×6 set in
the App names DLSS 4.5 only when the frames show it. A 310 library with no such evidence shows its
version only. ~~DLSS 5 is shown only as *runtime loaded*, by a library name not yet seen on a real game.~~ **DLSS 5**
version only. **DLSS 5**
(since 0.1.0-beta.34) is named where the game was seen running its neural rendering through Streamline, with the share
of rendered frames; its library loaded and nothing seen reads *runtime loaded* — *not seen running* only where the
Overlay looked. A game that runs neural rendering outside Streamline is not seen. Where each
@@ -202,6 +202,16 @@ you accept the prompt. Turn it on only if you trust everything that runs under y
anti-cheat, never to judge it, and recording or measuring a game vouches for nothing. Four itch.io downloads this
project once used as examples turned out to carry malware ([details](docs/spike-notes.md)).
## Accessibility
What works with the keyboard alone, a screen reader, a contrast theme or Magnifier, what does not yet, and how to report
a barrier is on its own page: [Accessibility](ACCESSIBILITY.md) (in the app: Help ▸ Accessibility). The largest limits:
- **Charts are pictures.** A screen reader cannot read their points; the numbers are in the session's figures, the
tables and **File ▸ Export**.
- **Windows' text size setting is not followed** — use display scaling or Magnifier.
- **Windows contrast themes are not followed yet** — choose **Light** or **Dark** in Settings ▸ Theme.
## Play
- **Through GOG GALAXY or itch, you finish in their app.** GOG GALAXY runs the game as its own shortcuts do, and the
+6 -4
View File
@@ -6,9 +6,10 @@
**New here? Start with the [user guide](guide/README.md)** — install, record a game, read your results, stay safe with
anti-cheat, and look after your data, a page each, then every screen, every setting and what to do when something goes
wrong. What FrameLedger cannot do is on one page: [Limitations](LIMITATIONS.md). Both are in the app too (Help ▸ User
guide, Help ▸ Limitations), and on the project's [wiki](https://github.com/poli0981/frameledger/wiki) with the developer
pages.
wrong. What FrameLedger cannot do is on one page: [Limitations](LIMITATIONS.md). How it works with the keyboard alone, a
screen reader or a contrast theme, and how to report a barrier: [Accessibility](ACCESSIBILITY.md). All three are in the
app too (Help ▸ User guide, Help ▸ Limitations, Help ▸ Accessibility), and on the project's
[wiki](https://github.com/poli0981/frameledger/wiki) with the developer pages.
<!-- accuracy-block:begin -->
> ⚠ **What FrameLedger actually measures today — 2026-11-06.** The software is a beta; its latest
@@ -203,7 +204,8 @@ FrameLedger is GPL-3.0-only free software, and you are welcome to build it, chan
- **Build it:** [`docs/12_BUILD.md`](docs/12_BUILD.md) — `./build.ps1 check` is the whole quality gate, the same one CI runs.
- **Contribute:** [`CONTRIBUTING.md`](CONTRIBUTING.md) — the definition of done, what will not be merged, and that a
contribution is licensed GPL-3.0-only with the [`NOTICE`](NOTICE) terms (no CLA). Conduct:
[`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md). Security reports: [`SECURITY.md`](SECURITY.md).
[`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md). Security reports: [`SECURITY.md`](SECURITY.md). Accessibility — the goal,
the checks and how a barrier is reported: [`ACCESSIBILITY.md`](ACCESSIBILITY.md).
- **Fork or redistribute:** [`FORKING.md`](FORKING.md) — what the GPL asks of anyone who distributes builds, and the names
a fork must change so it does not share FrameLedger's update feed, install folder, data, pipe or Vulkan layer.
- **Find your way around:** the [wiki](https://github.com/poli0981/frameledger/wiki)'s developer pages are short, and each
+1 -1
View File
@@ -467,7 +467,7 @@ function Invoke-ProjectGates {
Invoke-Checked 'notice-check (self-test)' { & $noticeTool -SelfTest }
Invoke-Checked 'notice-check' { & $noticeTool -RepoRoot $repo }
# beta.17 (D53/D54): the GitHub Wiki is built from wiki/, guide/ and LIMITATIONS.md, and wiki.yml publishes it when a
# beta.17 (D53/D54): the GitHub Wiki is built from wiki/, guide/, LIMITATIONS.md and (beta.35) ACCESSIBILITY.md, and wiki.yml publishes it when a
# release is made. A link or a section that leads nowhere, a page nothing leads to, a sidebar out of the guide's
# order, a path that names nothing or a version written into a page is red here, not on the published wiki.
# Self-test first (nine cases, both directions), then the live assembly into a temporary folder.
+1 -1
View File
@@ -113,7 +113,7 @@ Draw live FPS/frametime/upscaler info inside the game. Only for games already ho
- **NFR-6 Accuracy:** per `03_METRICS` §Accuracy budget, stated per tier.
- **NFR-7 Resilience:** power loss loses at most the last 60 s of raw data; DB never corrupts (WAL + transactions); Agent restart recovers `.partial` sessions as `interrupted`.
- **NFR-8 OS support:** Windows 10 22H2+ and Windows 11, x64. No ARM64 in v1.
- **NFR-9 Accessibility:** full keyboard navigation, adequate contrast in both Fluent themes, Per-Monitor V2 DPI awareness. *(What each clause means for this app, and the check that holds it: `08_UI` §Accessibility, P4 PR-8.)*
- **NFR-9 Accessibility:** full keyboard navigation, adequate contrast in both Fluent themes, Per-Monitor V2 DPI awareness. *(What each clause means for this app, and the check that holds it: `08_UI` §Accessibility, P4 PR-8.)* *(Widened 2026-11-09, beta.35, owner decisions D88–D91: and a screen reader reads every control and value and is told what changes; Windows contrast themes are followed; nothing is shown by colour alone. The goal behind all of it is WCAG 2.2 AA as W3C's WCAG2ICT applies it to desktop software — a goal, not a conformance claim — stated to users in `ACCESSIBILITY.md`.)*
- **NFR-10 Offline-first:** everything except updates and opt-in metadata works with zero connectivity.
- **NFR-11 Auditability:** the entire set of hooks is enumerable in `17_HOOK_ENGINE` §Hook inventory and matches the code; a reviewer must be able to verify in minutes that nothing reads game memory.
+36 -4
View File
@@ -43,8 +43,13 @@ Compare showed the icon alone)*. Light/Dark/System themes via `ApplicationThemeM
**Menu bar**
- **File:** Add game… · Import library (Steam / GOG / Epic / itch.io / Xbox *— since beta.33*) · Export ▸ (Session CSV / Session JSON / Chart PNG) · Exit
- **Tools:** Agent status… · Update detection rules · Vulkan layer registration… · Open data folder · Database maintenance…
- **Help:** User guide (beta.12) · Check for updates · Report a bug… · ~~Documentation~~ Online documentation · Limitations · About FrameLedger (~~App / Developer / Third-party licenses tabs~~ — built beta.12 as *This app* / *Third-party licences* / *Legal documents*, below)
- **Help:** User guide (beta.12) · Check for updates · Report a bug… · ~~Documentation~~ Online documentation · Limitations · Accessibility (beta.35) · About FrameLedger (~~App / Developer / Third-party licenses tabs~~ — built beta.12 as *This app* / *Third-party licences* / *Legal documents*, below)
> **Help ▸ Accessibility, beta.35 (owner decision D88, 2026-11-09):** `ACCESSIBILITY.md` — the accessibility statement —
> as the build embeds it (`Services.AccessibilityDocument`), in a `Windows/DocumentWindow` of its own like Limitations,
> and after Limitations in the user guide's window so the guide's links to it open there. Information, not one of
> FR-11's documents. What it says and the checks behind it are §Accessibility below.
>
> **Help ▸ Limitations, beta.10 (D36):** `LIMITATIONS.md` as the build embeds it (`Services.LimitationsDocument`), in a
> ~~read-only, scrolling WPF UI `MessageBox` with *Open on GitHub*~~ window of its own since beta.12 (`Windows/DocumentWindow`,
> rendered — below; corrected 2026-10-04). It is information, not one of FR-11's documents:
@@ -1007,12 +1012,22 @@ NFR-9 names three things — full keyboard navigation, adequate contrast in both
and this section is what they mean for this app, each with the test that holds it (P4 PR-8, 2026-09-15). Until then
the requirement was one bullet under §UX rules, and nothing checked it.
> **The users' half is `ACCESSIBILITY.md` (beta.35, owner decision D88, 2026-11-09):** the goal — WCAG 2.2 AA as W3C's
> WCAG2ICT applies it to desktop software, a goal and never a conformance claim — what works, what does not and what to do
> instead, and how a barrier is reported (the *Accessibility problem* form, `labels: [accessibility]`) and handled (by
> severity, no promised times). It is embedded and shown under Help ▸ Accessibility. **This section is the design and the
> checks; the statement says nothing this section does not hold**, and a change that moves either changes both
> (`AccessibilityDocumentTests` holds the statement's own rules: embedded as written, a goal and no claim, a form that
> exists, no struck text in a page the App shows). NFR-9 was widened the same day to screen readers and contrast themes
> (D88–D91).
### Keyboard
| Keys | Does | Where |
|---|---|---|
| **Ctrl+1 … Ctrl+5** (and the numeric keypad's 1–5) | Dashboard · Games · Compare · Logs · Settings | `MainWindow` `InputBindings` → `MainWindowViewModel.NavigateToCommand` → `ShellShortcuts` |
| **Alt**, **F10** | Focuses the menu bar; arrows and Enter walk File / Tools / Help | WPF `Menu`, nothing custom |
| **Alt** + a menu's access key | Opens that menu — `_File` `_Tools` `_Help`; `_Tệp` `_Công cụ` `Trợ _giúp`; `ファイル(_F)` `ツール(_T)` `ヘルプ(_H)` *(row added 2026-11-09: the keys existed since P3 and this table did not name them)* | the `Menu_*` strings' `_` |
| **Tab / Shift+Tab** | Moves through a page in reading order | layout order; no `TabIndex` overrides |
| **Arrows, Home/End, Page Up/Down** | Move within a `DataGrid` (Sessions, Compare picker, Import checklist) | `DataGrid` defaults |
| **Esc** | Closes the open `ContentDialog` or `MessageBox` with no result — the same as its Close/Cancel button | `DialogKeyboard`, one class handler per dialog type registered at start-up |
@@ -1040,6 +1055,10 @@ handled key — so whether Esc alone would close a dialog through `IsCancel` is
`TextBox`, `NumberBox`, `PasswordBox`, `Slider` and `HyperlinkButton` in the App's XAML either has content or a name. A new
unnamed one is red.
- Status lines that change after an action (the Database maintenance result) are `AutomationProperties.LiveSetting="Polite"`.
*(Corrected 2026-11-09: this announces nothing. WPF raises `LiveRegionChanged` only when the app raises it — "you
explicitly raise an event", Microsoft's* What's new in accessibility *for 4.7.1 — and `TextBlockAutomationPeer` raises
none (dotnet/wpf); the App raised no automation event anywhere. The setting marks the line as a live region and no
more.)*
### Contrast
@@ -1130,8 +1149,21 @@ ScottPlot reads once when the control is made, before it has a window.
### Known gaps, stated
- ScottPlot plots are not keyboard-operable (no focus, no pan/zoom by keys). The numbers behind them are on the
- ~~ScottPlot plots are not keyboard-operable (no focus, no pan/zoom by keys).~~ *(Corrected 2026-11-09, measured by
`ChartKeyboardTests` in a window off the screen: a plot takes focus — ScottPlot's control is focusable and a Tab stop —
and the keys ScottPlot reads reach it: the arrows pan, Ctrl with an arrow zooms, A shows all of it. What it is not is
usable: it has no automation peer, so Narrator says nothing on reaching it, and it marks no key handled, so the page
around it acts on the same arrow too.)* The numbers behind them are on the
session summary's stat cards and in File ▸ Export (CSV/JSON); the hardware-change markers' text is WPF text in the
list under each trend chart (beta.30).
- No screen-reader pass with Narrator has been done; the names above are necessary, not proven sufficient. That pass
is the owner's.
- ~~No screen-reader pass with Narrator has been done; the names above are necessary, not proven sufficient. That pass
is the owner's.~~ **The owner's pass, 2026-11-09: keyboard only with the mouse disconnected, and Narrator, on
0.1.0-beta.34 and 0.1.0-alpha.3 — every page, menu, dialog and setting reached and used, no fault.**
- **What that pass could not show**, found the same day by measuring the UI Automation tree WPF builds (in memory, on
.NET 10.0.14 — not by listening): a drop-down's items are named by a record's printed form (`Choice { Value = dark,
Label = Dark }`) and plain lists' items by their type; a control with no automation peer that still takes focus — a
chart, the FPS readout, the RT/PT/RR chips, the game's artwork — is a Tab stop Narrator says nothing about; text inside
a control template (the safety notices' title and message, the readout, the chips) is hidden from the control view;
nothing is announced; no text is a heading; several charts tell series apart by colour alone; page transitions play
with Windows' animation effects off; Windows contrast themes are not followed. `ACCESSIBILITY.md` §Known limitations
states each to users with what to do instead.
+1 -1
View File
@@ -355,7 +355,7 @@ would not fit).
13b. `tools/accuracy-check.ps1 -SelfTest`, then live — the accuracy block is ONE text (`legal/ACCURACY.md`) embedded verbatim in `README.md` and `legal/DISCLAIMER.md` §4; a copy that drifted, a copy with no markers, or an empty source is red. Four self-test cases, both directions (§S23-6, 2026-09-06)
13c. **`tools/notice-check.ps1 -SelfTest`, then live** (beta.12, owner decision D45, 2026-10-03) — every first-party source file (`.cs .cpp .h .inl .ps1 .xaml`, tracked or new, minus `src/native/third_party/`) opens with `SPDX-License-Identifier: GPL-3.0-only` and `Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE` in its own comment syntax, because GPLv3 §7 wants additional terms named "in the relevant source files" (`NOTICE` carries them); the second line may name another holder and year in the same form (a contributor's own file).
Seven self-test cases, both directions; `./tools/notice-check.ps1 -Fix` writes a missing header, and `tools/resx-gen.ps1` generates the accessor with it
13d. **`tools/wiki-build.ps1 -SelfTest`, then `-Check`** (beta.17, owner decisions D53/D54, 2026-10-07) — assembles the GitHub Wiki from `wiki/`, `guide/` and `LIMITATIONS.md` into a temporary folder, as `wiki.yml` does at a release (`13_CI_CD` §wiki.yml), and fails on a link to a file, folder or section that does not exist, two sources for one page, a page that neither Home nor the sidebar leads to, a sidebar that lists the guide in another order than `guide/README.md`, a backticked repository path in a `wiki/` page that names nothing, and a version number written into a `wiki/` page (the footer says which release the wiki shows). Nine self-test cases, both directions
13d. **`tools/wiki-build.ps1 -SelfTest`, then `-Check`** (beta.17, owner decisions D53/D54, 2026-10-07) — assembles the GitHub Wiki from `wiki/`, `guide/`, `LIMITATIONS.md` and (beta.35) `ACCESSIBILITY.md` into a temporary folder, as `wiki.yml` does at a release (`13_CI_CD` §wiki.yml), and fails on a link to a file, folder or section that does not exist, two sources for one page, a page that neither Home nor the sidebar leads to, a sidebar that lists the guide in another order than `guide/README.md`, a backticked repository path in a `wiki/` page that names nothing, and a version number written into a `wiki/` page (the footer says which release the wiki shows). ~~Nine~~ Ten self-test cases since beta.35 (the statement's page, D88), both directions
14. `tools/changelog-check.ps1 -SelfTest` — nine cases, five expected RED. The live half needs a pull request's changed-file list and is supplied by `ci.yml`
14b. `tools/release-notes.ps1 -SelfTest` — five cases over a fixture changelog (a dated and an undated section, a missing one, a prefix that must not match, an empty one), and since beta.24 three over a temporary tree: a version with its own `docs/changelog/<version>.md` is read from it, one without from `CHANGELOG.md`, a prefix of a file name is not that file. The live half needs a tag's version and runs in `release.yml`, where a missing or empty section is a red release (P4 PR-5)
14d. **`tools/docs-split-check.ps1 -SelfTest`, then live** (beta.24, owner decision D66) — `CHANGELOG.md` holds no released section beside `[Unreleased]`; each `docs/changelog/<version>.md` holds one `## ` heading, its own `## [<version>] - date`, and no relative link (the App renders release notes as `CHANGELOG.md`); `CHANGELOG.md` and the files under `docs/changelog/`, and `docs/HANDOFF.md` and the files under `docs/handoff/` — and since PR-5 `docs/20_OPEN_QUESTIONS.md` and `docs/open-questions/`, `docs/spike-notes.md` and `docs/spike-notes/` — name each other in both directions. Eleven self-test cases, both directions
+8 -6
View File
@@ -211,9 +211,9 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
### `wiki.yml` — after a successful Release run, and by hand · **repo-local, built 2026-10-07 (beta.17, D53/D54)**
- **What:** the GitHub Wiki is a copy of the repository's own pages — `wiki/` (Home, the sidebar, the developer pages)
and `guide/` (the user guide: the End-user part, the same pages the App shows) with `LIMITATIONS.md`.
`tools/wiki-build.ps1` names each page (a guide page after its first heading, `guide/README.md` as *User-guide*,
`LIMITATIONS.md` as *Limitations*), rewrites links between pages to page names and every other repository link to
and `guide/` (the user guide: the End-user part, the same pages the App shows) with `LIMITATIONS.md` and, since
beta.35 (D88), `ACCESSIBILITY.md`. `tools/wiki-build.ps1` names each page (a guide page after its first heading,
`guide/README.md` as *User-guide*, `LIMITATIONS.md` as *Limitations*, `ACCESSIBILITY.md` as *Accessibility*), rewrites links between pages to page names and every other repository link to
its address on GitHub **at the release's tag**, drops each page's first heading (the wiki prints the page name), and
writes a footer naming the tag. The same assembly is `build.ps1`'s `wiki-check` gate (`12_BUILD` §Local quality gate,
13d), so a dead link is red on the pull request, never on the published wiki.
@@ -252,8 +252,8 @@ What it is and what differs on the branch: `12_BUILD` §The alpha line. What CI
warning, its row in `CHANGELOG.md`'s Releases table, a line in HANDOFF's START HERE) → the sync pull request into
`alpha` → a `release.yml` dispatch on `alpha` (`gh workflow run release.yml --ref alpha -f version=x.y.z-alpha.N`) →
the signed tag on `alpha`'s head → the run (§release.yml: the line's tag rule, `--channel alpha`). **No wiki publish**
(`wiki.yml` skips an `-alpha.` tag) and **no release line moves**: README, ACCURACY, the Disclaimer's copy and
LIMITATIONS keep naming the newest beta.
(`wiki.yml` skips an `-alpha.` tag) and **no release line moves**: README, ACCURACY, the Disclaimer's copy,
LIMITATIONS and ACCESSIBILITY keep naming the newest beta.
- **The cadence:** one alpha per beta, cut from it. Velopack's GitHub source reads the newest ten releases (one page,
`perPage` 10), so ten alphas in a row would hide every beta from the betas' own update check, and the other way round
(`11_UPDATER` §Channels).
@@ -545,7 +545,9 @@ Central package management makes Dependabot PRs single-file diffs.
**In the tree — done:**
- [x] Repo-local `ci.yml`, `codeql.yml`, `release.yml`, `rules-publish.yml` (all four repo-local by decision, §Workflows); ~~caller stubs pointing at `poli0981/.github`~~ — never the design, see the first paragraph *(and `wiki.yml` since beta.17, repo-local too: five)*
- [x] Issue forms `bug_report.yml`, `feature_request.yml`, `safety_gap.yml`; `ISSUE_TEMPLATE/config.yml` pointing a vulnerability at private reporting; PR template referencing CLAUDE.md's definition of done
- [x] Issue forms `bug_report.yml`, `feature_request.yml`, `safety_gap.yml`; `ISSUE_TEMPLATE/config.yml` pointing a vulnerability at private reporting; PR template referencing CLAUDE.md's definition of done *(and since 2026-11-09, beta.35, D88: `accessibility.yml`, the form `ACCESSIBILITY.md` sends a barrier to, and the PR template's user-interface section)*
- [x] The labels the forms apply exist *(2026-11-09: `accessibility`, and `safety` and `priority-high`, which `safety_gap.yml` had named since it was written (2026-08-02) while the repository had neither — GitHub applies only a label that exists, so no Safety gap report was ever labelled)*
- [x] `ACCESSIBILITY.md` — the accessibility statement: WCAG 2.2 AA through WCAG2ICT as a goal, never a claim; how a barrier is reported and handled (2026-11-09, D88)
- [x] `.github/dependabot.yml` (nuget + github-actions, weekly; a seven-day cooldown and the actions grouped since 2026-10-25 — and a NuGet library update it never proposed is `dotnet list package --outdated`'s to find, §Dependabot and the NuGet audit)
- [x] `SECURITY.md` — the private route for a vulnerability, the public route for a safety gap, and the honest response intent (2026-09-16)
- [x] A release rehearsal: `release.yml` `workflow_dispatch` runs every step but the Release itself (§release.yml)
+5
View File
@@ -209,9 +209,14 @@ that it was checked against anything.
| Mode | launch mode · attach mode · mid-session settings change |
| Safety | game with anti-cheat → toggle disabled · simulated late AC load → unhook · double-crash → auto-disable |
| Tier | forced Tier 2 (records duration, available sensors and the reason — and nothing else) · Tier 1 → Tier 2 degradation notice |
| Accessibility *(added 2026-11-09, beta.35, D88)* | **keyboard only** with the mouse disconnected — every page, menu and dialog, Ctrl+1…5, Esc · **Narrator** — names, values, headings, the notices as they appear · a **contrast theme** on and off (Aquatic, Desert) · Windows **animation effects** off · a large **display scale**. The owner's first pass: 2026-11-09, keyboard only and Narrator on 0.1.0-beta.34 and 0.1.0-alpha.3, no fault (`ACCESSIBILITY.md` §How it is checked; the automated half is `08_UI` §Accessibility) |
| Update | Velopack delta; update deferred while a game is hooked (FR-12) — *a delta needs a previous release, so this row is reachable from the second release, not the first* *(corrected 2026-10-04: no release has carried a delta — `release.yml` never fetches the previous release before `vpk pack`, `11_UPDATER` §Built — so the update leg is a full package; **since beta.13** a release carries a delta against the previous one, and the first
update that can use it is beta.12 → beta.13 — HANDOFF owner-only item 10)* |
## Release smoke
Clean-VM install → Legal Gate → Agent setup (unelevated) → add a game → consent dialog → hooked 2-min session → charts render → CSV opens in Excel → Vulkan layer registered/unregistered cleanly → uninstall removes layer registration, task, and asks about data.
*(Added 2026-11-09, beta.35, D88:)* and an **accessibility smoke**, the same build: the Legal Gate, the consent dialog and
the session summary reached and answered with the keyboard alone; Narrator reads the notice a refused game raises; the
window readable under one contrast theme. The release's owner-only item in `HANDOFF` lists what that release moved.
+1 -1
View File
@@ -1913,7 +1913,7 @@ Each of these is referenced by an existing doc but specified nowhere.
| ~~**Threading model**~~ | ~~Which component owns which thread, UI-thread rules, and how the 1 Hz telemetry poller, 10 Hz drain and pipe reader interact~~ **Answered 2026-09-09 (P2 PR-C): `04_CAPTURE` §Threading model** — four threads, one owner per shared object, the pipe reader named as one more producer. This row was not struck when the section was written; struck 2026-09-13. What is still unspecified is the UI thread's own rules, which is `08_UI`'s in P3 | `04_CAPTURE`, `18_GPU_VENDOR_APIS` |
| **Pipe/shm security** | Stated as policy ("DACL granting the current user's SID") but not as implementable SDDL, nor who creates the objects with what rights. The shm half is built (`fl_shm_host.h`, the Overlay creates the section under the current user's SID); the pipe half is **built 2026-09-13 (P3 PR-1, HANDOFF §P3 decision D11)**: `D:P(A;;GA;;;<user>)(A;;GA;;;BA)` (with the owner `O:<user>` stated since 2026-09-17, `07_IPC` §C) handed to `CreateNamedPipe` with `PIPE_REJECT_REMOTE_CLIENTS`, and the client's token user compared by impersonation on its first frame (`Infrastructure.Ipc.PipeAccessControl`, pinned by `PipeServerClientTests` including the refused stranger). **Row closed** | `07_IPC` |
| ~~**Legal doc versioning**~~ | ~~FR-11 re-shows documents "when a document version increments". Nothing says where the current version lives, who writes `legal_acceptance.version`, or how the markdown is rendered in-app~~ **Answered 2026-09-14 (P3 PR-9):** the version is the document's own `**Version:**` line, read from the copy embedded in the App at build (`App.Services.LegalDocuments`); the App writes `legal_acceptance.version` on the one Accept and re-shows any document whose embedded version differs from its row; ~~the markdown is shown as text with authoring comments stripped, not rendered~~ the markdown is shown with authoring comments stripped and, since beta.12, rendered (`08_UI` §Menu, *Documents are rendered*; §First-run flow built note) | FR-11, `06_DATA_MODEL` |
| **Accessibility / DPI** | NFR-9 states requirements; no design anywhere | NFR-9, `08_UI` |
| ~~**Accessibility / DPI**~~ | ~~NFR-9 states requirements; no design anywhere~~ **Answered 2026-09-15 (P4 PR-8): `08_UI` §Accessibility** — what each clause of NFR-9 means here and the check that holds it; this row was not struck then. Since 2026-11-09 (beta.35, D88) the users' half is `ACCESSIBILITY.md`, and NFR-9 names screen readers and contrast themes too. **Row closed** | NFR-9, `08_UI` |
| **Uninstall / data deletion** | One Velopack clause. No in-app "delete all my data", despite the privacy position | `12_BUILD`, `legal/PRIVACY_POLICY.md` |
| ~~**Cover art**~~ | ~~Appears in the schema, the data directory and the UI; nothing says where it comes from or the licence position on downloaded store art~~ **Answered 2026-10-14 (beta.23, owner decisions D60/D61):** from the user's own image (a copy in `covers\`) or what the Steam and GOG GALAXY apps already keep on this PC — nothing is downloaded, so no store art is redistributed or fetched; the art stays its owners' (`legal/TRADEMARKS.md`), the Privacy Policy 2.11 names the files read. `08_UI` §Games › Game detail. **Row closed** | `06_DATA_MODEL`, `05_DETECTION` |
| **The main line's .NET** *(added 2026-10-31, D73–D76)* | **When does the main line — the betas and the first release — leave .NET 10 LTS, and for what?** The alpha line (`12_BUILD` §The alpha line) builds the same source on .NET 11 to gather the evidence; it decides nothing by existing. What is known: .NET 11 is STS, supported 24 months to about 2028-11, no later than .NET 10 LTS (2028-11-14), so moving buys no support time; Microsoft's supported-OS list for .NET 11 has Windows 10 only in its LTSC and IoT editions, against NFR-8's Windows 10 22H2 floor; C# 15's unions and closed hierarchies would suit the tri-states and refusal reasons, but only once the main line compiles C# 15. **Decision table, written before the evidence:** move to .NET 11 only if (a) at least two alphas on the GA runtime pass the gate and an owner's run of a hooked title with no runtime-specific defect, (b) the owner accepts dropping NFR-8's floor to Windows 11 or ships knowingly unsupported on Windows 10, and (c) something .NET 11 brings is wanted — a measured gain or a language feature; otherwise stay on .NET 10 and take .NET 12 LTS (expected 2027-11) the same way, through the alpha line first | `12_BUILD`, `13_CI_CD`, `02_SPEC` NFR-8, CLAUDE.md pinned stack |
+5 -1
View File
@@ -11,7 +11,7 @@ This folder is for people who build, change or review FrameLedger. **If you only
| Find your way around first | The [wiki](https://github.com/poli0981/frameledger/wiki)'s developer pages (source: [`../wiki/`](../wiki/), beta.17) — a short page per part, each linking here |
| Learn the system | [`../CLAUDE.md`](../CLAUDE.md) (the rules and the layout), then the reading order below |
| Build it | [`12_BUILD.md`](12_BUILD.md) — `./build.ps1 check` is the whole gate, the same one CI runs |
| Contribute or fork | [`../CONTRIBUTING.md`](../CONTRIBUTING.md), [`../FORKING.md`](../FORKING.md), [`../NOTICE`](../NOTICE) |
| Contribute or fork | [`../CONTRIBUTING.md`](../CONTRIBUTING.md), [`../FORKING.md`](../FORKING.md), [`../NOTICE`](../NOTICE), [`../CODE_OF_CONDUCT.md`](../CODE_OF_CONDUCT.md) *(it and `SECURITY.md`, below, added 2026-11-09: the index named neither)* |
**Status lives in four places, and nowhere else** — check a status claim against the code before you plan on it:
@@ -87,5 +87,9 @@ are safety items, and something listed there as unresolved should not be built t
- [`../legal/`](../legal/) — the documents a user accepts, the accuracy statement, the third-party notices and licence
texts, the trademark note.
- [`../LIMITATIONS.md`](../LIMITATIONS.md) — what the whole software cannot do, in a player's words.
- [`../ACCESSIBILITY.md`](../ACCESSIBILITY.md) — the accessibility statement (beta.35, D88): the goal, what works with the
keyboard, a screen reader and contrast themes, the known limits and how a barrier is reported; shown in the App under
Help ▸ Accessibility. Its checks are [`08_UI.md`](08_UI.md) §Accessibility.
- [`../SECURITY.md`](../SECURITY.md) — the private route for a vulnerability, and why the guard has no override.
- [`../rules/detection-rules.json`](../rules/detection-rules.json) — engine, platform and capability signatures and the
anti-cheat blocklist, validated by `tools/rules-validate.ps1`.
+18 -13
View File
@@ -27,20 +27,21 @@ stopped, hooking turned off — each with one button that only says you have rea
| Menu | Item | What it does |
|---|---|---|
| **File** | **Add game…** | Pick a game's `.exe` file. It is added with hooking off, and its page opens. |
| | **Import library…** | A checklist of the games installed through Steam, GOG Galaxy, Epic, itch.io and the Xbox app (or the Microsoft Store). |
| | **Export** ▸ **Session CSV** · **Session JSON** · **Chart PNG** | Saves the session you last selected or opened. Read [Your data](05-your-data.md) before you share a file. |
| | **Exit** | Quits FrameLedger, even when *Minimize to tray on close* is on. |
| **File** | **Import library…** | A checklist of the games installed through Steam, GOG Galaxy, Epic, itch.io and the Xbox app (or the Microsoft Store). |
| **File** | **Export** ▸ **Session CSV** · **Session JSON** · **Chart PNG** | Saves the session you last selected or opened. Read [Your data](05-your-data.md) before you share a file. |
| **File** | **Exit** | Quits FrameLedger, even when *Minimize to tray on close* is on. |
| **Tools** | **Agent status…** | Opens the Dashboard, where the agent's card is. |
| | **Update detection rules** | The agent reads its detection rules again and checks your games again. |
| | **Vulkan layer registration…** | Opens Settings, where the Vulkan layer is. |
| | **Open data folder** | Opens `%LOCALAPPDATA%\FrameLedger` in Explorer. |
| | **Database maintenance…** | **Check**, **Back up…**, **Sweep…** and **Compact** your database ([When something goes wrong](09-troubleshooting.md#the-database)). |
| **Tools** | **Update detection rules** | The agent reads its detection rules again and checks your games again. |
| **Tools** | **Vulkan layer registration…** | Opens Settings, where the Vulkan layer is. |
| **Tools** | **Open data folder** | Opens `%LOCALAPPDATA%\FrameLedger` in Explorer. |
| **Tools** | **Database maintenance…** | **Check**, **Back up…**, **Sweep…** and **Compact** your database ([When something goes wrong](09-troubleshooting.md#the-database)). |
| **Help** | **User guide** | This guide. |
| | **Check for updates** | Asks GitHub now. |
| | **Report a bug…** | Builds a report on your PC ([When something goes wrong](09-troubleshooting.md#report-a-problem)). |
| | **Online documentation** | The project's page on GitHub. |
| | **Limitations** | What FrameLedger cannot do. |
| | **About FrameLedger** | The version, the licences and the notices. |
| **Help** | **Check for updates** | Asks GitHub now. |
| **Help** | **Report a bug…** | Builds a report on your PC ([When something goes wrong](09-troubleshooting.md#report-a-problem)). |
| **Help** | **Online documentation** | The project's page on GitHub. |
| **Help** | **Limitations** | What FrameLedger cannot do. |
| **Help** | **Accessibility** | What works with the keyboard alone, a screen reader or a contrast theme, what does not yet, and how to report a problem. |
| **Help** | **About FrameLedger** | The version, the licences and the notices. |
## Dashboard
@@ -133,7 +134,11 @@ is ready.
## Keyboard and mouse
- **Ctrl+1** … **Ctrl+5** open Dashboard, Games, Compare, Logs and Settings.
- **Alt** or **F10** moves to the menus.
- **Alt** or **F10** moves to the menus; **Alt** with a menu's underlined letter opens it (**Alt+F**, **Alt+T** and
**Alt+H** for File, Tools and Help in English).
- **Esc** closes a dialog the way its Close or Cancel button does.
- Over a chart, **Ctrl** and the mouse wheel zoom, dragging pans, and a double-click resets. The wheel alone scrolls the
page.
What works with the keyboard alone, a screen reader or a contrast theme — and what does not yet — is on its own page:
[Accessibility](../ACCESSIBILITY.md) (Help ▸ Accessibility).
+2 -1
View File
@@ -20,7 +20,8 @@ Each page below takes a minute or two to read. The first six are the guide; the
12. [The terms, in plain words](terms-in-plain-words.md)
What FrameLedger cannot do is listed on its own page: [Limitations](../LIMITATIONS.md) (in the app: Help ▸
Limitations).
Limitations). How it works with the keyboard alone, a screen reader or a contrast theme, and how to report a problem:
[Accessibility](../ACCESSIBILITY.md) (Help ▸ Accessibility).
**FrameLedger is beta software.** It certainly still has bugs. If something goes wrong, Help ▸ Report a bug… builds a
report on your PC that you can look at before you decide to share it.
@@ -53,6 +53,8 @@
<EmbeddedResource Include="..\..\LICENSE" LogicalName="LICENSE" />
<!-- beta.10 (D36): what the whole software cannot do, shown under Help > Limitations; information, not one of FR-11's accepted documents. -->
<EmbeddedResource Include="..\..\LIMITATIONS.md" LogicalName="LIMITATIONS.md" />
<!-- beta.35 (D88): the accessibility statement, shown under Help > Accessibility; information, not one of FR-11's accepted documents. -->
<EmbeddedResource Include="..\..\ACCESSIBILITY.md" LogicalName="ACCESSIBILITY.md" />
<!-- beta.12: what Help > About shows, rendered from the text this build carries (D45: the copyright line and the GPLv3
section 7 terms, the trademark note, the third-party notices and the index of every shipped package's licence). -->
<EmbeddedResource Include="..\..\NOTICE" LogicalName="NOTICE" />
+1
View File
@@ -86,6 +86,7 @@
<MenuItem Header="{x:Static res:Strings.Menu_Help_ReportBug}" Command="{Binding ViewModel.ReportBugCommand}" />
<MenuItem Header="{x:Static res:Strings.Menu_Help_Documentation}" Command="{Binding ViewModel.DocumentationCommand}" />
<MenuItem Header="{x:Static res:Strings.Menu_Help_Limitations}" Command="{Binding ViewModel.LimitationsCommand}" />
<MenuItem Header="{x:Static res:Strings.Menu_Help_Accessibility}" Command="{Binding ViewModel.AccessibilityCommand}" />
<Separator />
<MenuItem Header="{x:Static res:Strings.Menu_Help_About}" Command="{Binding ViewModel.AboutCommand}" />
</MenuItem>
@@ -0,0 +1,35 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using System.IO;
namespace FrameLedger.App.Services;
/// <summary>
/// <c>ACCESSIBILITY.md</c> (beta.35, owner decision D88): the project's accessibility statement — what FrameLedger aims
/// for, what works with the keyboard, a screen reader and contrast themes, what does not yet, and how to report a
/// barrier — embedded at build time from the repository root and shown under Help ▸ Accessibility, so the App shows
/// exactly the text this build was reviewed with.
/// </summary>
/// <remarks>
/// <b>Information, not terms</b>, like <see cref="LimitationsDocument"/>: it is not one of FR-11's documents
/// (<see cref="LegalDocuments.Keys"/>), and nothing here is accepted.
/// </remarks>
public static class AccessibilityDocument
{
/// <summary>The embedded resource's name (<c>FrameLedger.App.csproj</c>).</summary>
public const string ResourceName = "ACCESSIBILITY.md";
/// <summary>The same text in the repository at this build's source, for the window's button.</summary>
public static readonly Uri OnGitHub = RepositoryLinks.Blob(ResourceName);
/// <summary>The document's text, authoring comments removed.</summary>
/// <exception cref="InvalidOperationException">The build did not embed it.</exception>
public static string Load()
{
using Stream stream = typeof(AccessibilityDocument).Assembly.GetManifestResourceStream(ResourceName)
?? throw new InvalidOperationException($"the build did not embed {ResourceName}");
using var reader = new StreamReader(stream);
return LegalDocuments.StripComments(reader.ReadToEnd());
}
}
@@ -14,6 +14,7 @@ public sealed class DocumentWindows(IUrlOpener urls, IThemeApplier theme, Appear
{
private DocumentWindow? _guide;
private DocumentWindow? _limitations;
private DocumentWindow? _accessibility;
private DocumentWindow? _alphaNotice;
private AboutWindow? _about;
@@ -44,6 +45,21 @@ public sealed class DocumentWindows(IUrlOpener urls, IThemeApplier theme, Appear
_limitations.Show();
}
public void ShowAccessibility()
{
if (Reveal(_accessibility))
{
return;
}
_accessibility = new DocumentWindow(Strings.Accessibility_Title, [new DocumentPage(Strings.Accessibility_Title, AccessibilityDocument.Load(), AccessibilityDocument.ResourceName)], urls, theme, appearance)
{
Owner = shell.Current,
};
_accessibility.Closed += (_, _) => _accessibility = null;
_accessibility.Show();
}
public void ShowAlphaNotice()
{
if (Reveal(_alphaNotice))
@@ -23,9 +23,9 @@ public static class EmbeddedDocuments
/// <summary>
/// The user guide's pages in reading order (beta.12, D44; <c>guide/</c> in the repository). Each page's title is its
/// first heading; <see cref="LimitationsDocument"/> closes the list, so the guide's links to it open in the window.
/// beta.17 (D54): the four reference pages after the FAQ make the guide the wiki's End-user part too; the alpha builds'
/// page joins them in beta.32 (D73).
/// first heading; <see cref="LimitationsDocument"/> and, since beta.35 (D88), <see cref="AccessibilityDocument"/> close
/// the list, so the guide's links to them open in the window. beta.17 (D54): the four reference pages after the FAQ make
/// the guide the wiki's End-user part too; the alpha builds' page joins them in beta.32 (D73).
/// </summary>
public static IReadOnlyList<string> GuidePages { get; } =
[
@@ -70,10 +70,13 @@ public static class EmbeddedDocuments
Page(Strings.About_Doc_Trademarks, Trademarks),
];
/// <summary>Help ▸ User guide: the guide's pages, each titled by its first heading, and the Limitations page after them.</summary>
/// <summary>
/// Help ▸ User guide: the guide's pages, each titled by its first heading, then the Limitations page and the
/// accessibility statement (beta.35, D88).
/// </summary>
public static IReadOnlyList<DocumentPage> Guide()
{
var pages = new List<DocumentPage>(GuidePages.Count + 1);
var pages = new List<DocumentPage>(GuidePages.Count + 2);
foreach (string path in GuidePages)
{
string text = Read(path);
@@ -81,6 +84,7 @@ public static class EmbeddedDocuments
}
pages.Add(new DocumentPage(Strings.Limitations_Title, LimitationsDocument.Load(), LimitationsDocument.ResourceName));
pages.Add(new DocumentPage(Strings.Accessibility_Title, AccessibilityDocument.Load(), AccessibilityDocument.ResourceName));
return pages;
}
@@ -19,4 +19,9 @@ public interface IDocumentWindows
void ShowAlphaNotice()
{
}
/// <summary>Help ▸ Accessibility (beta.35, D88): <c>ACCESSIBILITY.md</c>, rendered.</summary>
void ShowAccessibility()
{
}
}
+6
View File
@@ -64,6 +64,7 @@ public static class Strings
nameof(About_Version_Format),
nameof(About_ViewLicence),
nameof(About_ViewNotice),
nameof(Accessibility_Title),
nameof(AddGame_Added_Format),
nameof(AddGame_Dialog_Title),
nameof(AddGame_Failed_Format),
@@ -753,6 +754,7 @@ public static class Strings
nameof(Menu_File_ImportLibrary),
nameof(Menu_Help),
nameof(Menu_Help_About),
nameof(Menu_Help_Accessibility),
nameof(Menu_Help_CheckUpdates),
nameof(Menu_Help_Documentation),
nameof(Menu_Help_Guide),
@@ -1297,6 +1299,8 @@ public static class Strings
public static string About_ViewNotice => ResourceManager.GetString(nameof(About_ViewNotice), Culture) ?? nameof(About_ViewNotice);
public static string Accessibility_Title => ResourceManager.GetString(nameof(Accessibility_Title), Culture) ?? nameof(Accessibility_Title);
public static string AddGame_Added_Format => ResourceManager.GetString(nameof(AddGame_Added_Format), Culture) ?? nameof(AddGame_Added_Format);
public static string AddGame_Dialog_Title => ResourceManager.GetString(nameof(AddGame_Dialog_Title), Culture) ?? nameof(AddGame_Dialog_Title);
@@ -2675,6 +2679,8 @@ public static class Strings
public static string Menu_Help_About => ResourceManager.GetString(nameof(Menu_Help_About), Culture) ?? nameof(Menu_Help_About);
public static string Menu_Help_Accessibility => ResourceManager.GetString(nameof(Menu_Help_Accessibility), Culture) ?? nameof(Menu_Help_Accessibility);
public static string Menu_Help_CheckUpdates => ResourceManager.GetString(nameof(Menu_Help_CheckUpdates), Culture) ?? nameof(Menu_Help_CheckUpdates);
public static string Menu_Help_Documentation => ResourceManager.GetString(nameof(Menu_Help_Documentation), Culture) ?? nameof(Menu_Help_Documentation);
+8
View File
@@ -333,6 +333,14 @@
<value>FrameLedger にできないこと</value>
<comment>review</comment>
</data>
<data name="Menu_Help_Accessibility" xml:space="preserve">
<value>アクセシビリティ</value>
<comment>review</comment>
</data>
<data name="Accessibility_Title" xml:space="preserve">
<value>アクセシビリティ</value>
<comment>review</comment>
</data>
<data name="Menu_Help_ReportBug" xml:space="preserve">
<value>不具合を報告…</value>
<comment>review</comment>
+6
View File
@@ -255,6 +255,12 @@
<data name="Limitations_Title" xml:space="preserve">
<value>What FrameLedger cannot do</value>
</data>
<data name="Menu_Help_Accessibility" xml:space="preserve">
<value>Accessibility</value>
</data>
<data name="Accessibility_Title" xml:space="preserve">
<value>Accessibility</value>
</data>
<data name="Menu_Help_ReportBug" xml:space="preserve">
<value>Report a bug…</value>
</data>
+6
View File
@@ -250,6 +250,12 @@
<data name="Limitations_Title" xml:space="preserve">
<value>Những điều FrameLedger không làm được</value>
</data>
<data name="Menu_Help_Accessibility" xml:space="preserve">
<value>Trợ năng</value>
</data>
<data name="Accessibility_Title" xml:space="preserve">
<value>Trợ năng</value>
</data>
<data name="Menu_Help_ReportBug" xml:space="preserve">
<value>Báo lỗi…</value>
</data>
@@ -291,6 +291,13 @@ public sealed partial class MainWindowViewModel : ObservableObject, IDisposable,
[RelayCommand]
private void Limitations() => _documents.ShowLimitations();
/// <summary>
/// Help ▸ Accessibility (beta.35, D88): <c>ACCESSIBILITY.md</c> as this build embeds it — the accessibility statement, in a
/// window of its own like Limitations. Information, not terms — nothing is recorded.
/// </summary>
[RelayCommand]
private void Accessibility() => _documents.ShowAccessibility();
/// <summary>Help ▸ Report a bug… (P4 PR-3): <c>10_LOGGING</c> §Bug report flow steps 2–4, the same flow the Logs page's button runs.</summary>
[RelayCommand]
private async Task ReportBugAsync() => _ = await _bugReports.RunAsync().ConfigureAwait(true);
@@ -0,0 +1,84 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using System.IO;
using System.Text.RegularExpressions;
using FluentAssertions;
using FrameLedger.App.Services;
namespace FrameLedger.App.Tests;
/// <summary>
/// <c>ACCESSIBILITY.md</c> (beta.35, owner decision D88) rides in the assembly for Help ▸ Accessibility, is information rather
/// than one of FR-11's accepted documents, states WCAG 2.2 AA as a goal and never as a claim, sends a barrier to a form that
/// exists, and names only files that exist. The pages a user reads in the App strike nothing through: the App draws struck
/// text as a decoration, so a screen reader reads a withdrawn sentence as if it were current.
/// </summary>
public sealed partial class AccessibilityDocumentTests
{
[GeneratedRegex(@"\]\((?<target>[^)#\s]+)(#[^)]*)?\)", RegexOptions.ExplicitCapture, 1000)]
private static partial Regex Link();
/// <summary>A sentence that would claim conformance rather than state a goal.</summary>
[GeneratedRegex(@"\bFrameLedger (?:conforms|complies|meets WCAG|is (?:fully )?(?:accessible|compliant|conformant))", RegexOptions.IgnoreCase | RegexOptions.CultureInvariant, 1000)]
private static partial Regex Claim();
[Fact]
public void ItIsEmbeddedAsWrittenAndIsNotADocumentTheUserAccepts()
{
string text = AccessibilityDocument.Load();
text.Should().StartWith("# Accessibility").And.NotContain("<!--");
text.Should().Be(LegalDocuments.StripComments(File.ReadAllText(Path.Combine(AccessibilityTests.RepoRoot(), AccessibilityDocument.ResourceName))),
"the App shows the file this build was made from");
LegalDocuments.Keys.Should().NotContain(static k => k.Contains("access", StringComparison.OrdinalIgnoreCase),
"the Legal Gate records an acceptance per document it shows; this is information, not terms");
AccessibilityDocument.OnGitHub.Should().Be(new Uri("https://github.com/poli0981/frameledger/blob/main/ACCESSIBILITY.md"));
}
[Fact]
public void EveryRepositoryLinkNamesAFileThatExists()
{
string root = AccessibilityTests.RepoRoot();
string[] targets = [.. Link().Matches(AccessibilityDocument.Load()).Select(static m => m.Groups["target"].Value)
.Where(static t => !t.StartsWith("http", StringComparison.OrdinalIgnoreCase))];
targets.Should().NotBeEmpty("the statement links the guide and the developers' details");
foreach (string target in targets)
{
File.Exists(Path.Combine(root, target.Replace('/', Path.DirectorySeparatorChar))).Should().BeTrue($"ACCESSIBILITY.md links {target}");
}
}
/// <summary>D88: WCAG 2.2 AA through WCAG2ICT is a goal; no sentence says FrameLedger conforms, and a barrier has a form.</summary>
[Fact]
public void ItStatesAGoalAndNeverAConformanceClaim()
{
string text = AccessibilityDocument.Load();
text.Should().Contain("WCAG 2.2").And.Contain("level AA").And.Contain("WCAG2ICT").And.Contain("not a claim");
Claim().Matches(text).Select(static m => m.Value).Should().BeEmpty("D88: a goal, never a conformance claim — no evaluation has been made");
text.Should().Contain("https://github.com/poli0981/frameledger/issues/new?template=accessibility.yml");
string form = File.ReadAllText(Path.Combine(AccessibilityTests.RepoRoot(), ".github", "ISSUE_TEMPLATE", "accessibility.yml"));
form.Should().Contain("labels: [accessibility]", "the statement's form labels what it files").And.Contain("name: Accessibility problem");
}
/// <summary>
/// The user guide, LIMITATIONS and this statement are read in the App, where a struck sentence is drawn with a line through
/// it and read aloud as written. Say what is true now; the history is in the changelog.
/// </summary>
[Fact]
public void NoPageAUserReadsInTheAppStrikesTextThrough()
{
IEnumerable<(string Path, string Text)> pages = EmbeddedDocuments.GuidePages.Select(static p => (p, EmbeddedDocuments.Read(p)))
.Append((LimitationsDocument.ResourceName, LimitationsDocument.Load()))
.Append((AccessibilityDocument.ResourceName, AccessibilityDocument.Load()));
pages.Where(static p => OutsideCode(p.Text).Contains("~~", StringComparison.Ordinal)).Select(static p => p.Path)
.Should().BeEmpty("a screen reader reads struck text as current; rewrite the sentence instead");
}
/// <summary>The text outside fenced code blocks.</summary>
private static string OutsideCode(string markdown) => string.Join('\n', markdown.Split("```").Where(static (_, i) => i % 2 == 0));
}
@@ -0,0 +1,77 @@
// SPDX-License-Identifier: GPL-3.0-only
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
using System.Windows;
using System.Windows.Input;
using FluentAssertions;
using FrameLedger.App.Charts;
using ScottPlot.WPF;
namespace FrameLedger.App.Tests;
/// <summary>
/// What a chart does with the keyboard (beta.35): <c>08_UI</c> §Accessibility said ScottPlot plots take no focus and no
/// keys, and they take both. A chart is a Tab stop, and the keys ScottPlot reads reach it — the arrows pan, Ctrl with an
/// arrow zooms, A shows all of it. Driven in a real window off the screen, since a key needs the window's input source.
/// </summary>
public sealed class ChartKeyboardTests
{
[Fact]
public async Task AFocusedChartPansWithTheArrowsZoomsWithCtrlAndShowsAllWithA()
{
var facts = await PagesLoadTests.OnStaAsync(() =>
{
var plot = new WpfPlot { Width = 600, Height = 300 };
ChartTheme.Attach(plot);
_ = plot.Plot.Add.Signal(new double[] { 0, 1, 0, 1, 0, 1, 0 });
Window window = ScrollBarHidingTests.OffScreen(new Window { Content = plot });
try
{
window.Show();
Visuals.Pump();
plot.Plot.Axes.SetLimits(-5, 5, -1, 1);
plot.Refresh();
Visuals.Pump();
ScottPlot.AxisLimits start = plot.Plot.Axes.GetLimits();
Press(plot, System.Windows.Input.Key.Left, down: true);
Press(plot, System.Windows.Input.Key.Left, down: false);
ScottPlot.AxisLimits panned = plot.Plot.Axes.GetLimits();
Press(plot, System.Windows.Input.Key.LeftCtrl, down: true);
Press(plot, System.Windows.Input.Key.Up, down: true);
Press(plot, System.Windows.Input.Key.Up, down: false);
Press(plot, System.Windows.Input.Key.LeftCtrl, down: false);
ScottPlot.AxisLimits zoomed = plot.Plot.Axes.GetLimits();
Press(plot, System.Windows.Input.Key.A, down: true);
Press(plot, System.Windows.Input.Key.A, down: false);
ScottPlot.AxisLimits all = plot.Plot.Axes.GetLimits();
return new { plot.Focusable, plot.IsTabStop, Start = start, Panned = panned, Zoomed = zoomed, All = all };
}
finally
{
window.Close();
}
});
facts.Focusable.Should().BeTrue("ScottPlot makes its control focusable; Tab reaches every chart");
facts.IsTabStop.Should().BeTrue();
facts.Panned.Left.Should().BeLessThan(facts.Start.Left, "Left moves the view to earlier values");
(facts.Zoomed.Top - facts.Zoomed.Bottom).Should().BeLessThan(facts.Panned.Top - facts.Panned.Bottom, "Ctrl+Up zooms in vertically");
facts.All.Left.Should().BeGreaterThan(facts.Panned.Left, "A shows all of the data again");
facts.All.Right.Should().BeGreaterThanOrEqualTo(6, "the whole signal, seven points from 0 to 6, is in view after A");
}
/// <summary>Raises the key the way WPF would: preview, then the bubbling event, from the window's own input source.</summary>
private static void Press(WpfPlot plot, Key key, bool down)
{
PresentationSource source = PresentationSource.FromVisual(plot) ?? throw new InvalidOperationException("the plot has no input source");
var preview = new KeyEventArgs(Keyboard.PrimaryDevice, source, Environment.TickCount, key) { RoutedEvent = down ? Keyboard.PreviewKeyDownEvent : Keyboard.PreviewKeyUpEvent };
plot.RaiseEvent(preview);
var bubble = new KeyEventArgs(Keyboard.PrimaryDevice, source, Environment.TickCount, key) { RoutedEvent = down ? Keyboard.KeyDownEvent : Keyboard.KeyUpEvent };
plot.RaiseEvent(bubble);
Visuals.Pump();
}
}
@@ -85,7 +85,7 @@ public sealed class DocumentWindowsTests
}
});
facts.Pages.Should().Be(EmbeddedDocuments.GuidePages.Count + 1);
facts.Pages.Should().Be(EmbeddedDocuments.GuidePages.Count + 2, "the guide's pages, then Limitations and Accessibility");
facts.First.Should().Be("guide/README.md");
facts.Shown.Should().BeTrue();
facts.Now.Should().Be("guide/01-install.md");
@@ -123,6 +123,46 @@ public sealed class DocumentWindowsTests
facts.Path.Should().Be("legal/ALPHA_NOTICE.md");
}
/// <summary>D88: Help ▸ Accessibility opens the statement in one window — one page, no list — and asking again brings it forward.</summary>
[Fact]
public async Task TheAccessibilityStatementOpensInOneWindowAndAskingAgainRevealsIt()
{
var facts = await PagesLoadTests.OnStaAsync(() =>
{
var shell = new ShellHost(new ServiceCollection().BuildServiceProvider(), null!, null!, new WindowClosePolicy());
var documents = new DocumentWindows(new NoUrlOpener(), new NoTheme(), new AppearanceSettings(new MemorySettings()), shell);
documents.ShowAccessibility();
documents.ShowAccessibility();
DocumentWindow[] open = [.. System.Windows.Application.Current.Windows.OfType<DocumentWindow>()];
try
{
return new
{
Count = open.Length,
Title = open.Length > 0 ? open[0].Title : null,
Pages = open.Length > 0 ? open[0].Pages.Pages.Count : 0,
Path = open.Length > 0 ? open[0].Pages.SelectedPage?.Path : null,
ListShown = open.Length > 0 && open[0].Pages.FindName("PageList") is UIElement { Visibility: Visibility.Visible },
Anchors = open.Length > 0 ? open[0].Pages.Viewer.Anchors.Count : 0,
};
}
finally
{
foreach (DocumentWindow window in open)
{
window.Close();
}
}
});
facts.Count.Should().Be(1, "asking again brings the open window forward rather than stacking a copy");
facts.Title.Should().Be(Strings.Accessibility_Title);
facts.Pages.Should().Be(1);
facts.Path.Should().Be(AccessibilityDocument.ResourceName);
facts.ListShown.Should().BeFalse("one page needs no list");
facts.Anchors.Should().BeGreaterThan(5, "every section of the statement is a heading a link can scroll to");
}
[Fact]
public async Task LimitationsIsOnePageWithNoListAndOpensOnGitHubAtThisBuildsSource()
{
@@ -34,14 +34,15 @@ public sealed class GuideDocumentsTests
}
[Fact]
public void EveryPageIsEmbeddedTitledAndListedAndLimitationsClosesTheList()
public void EveryPageIsEmbeddedTitledAndListedAndLimitationsAndAccessibilityCloseTheList()
{
IReadOnlyList<DocumentPage> pages = EmbeddedDocuments.Guide();
pages.Should().HaveCount(EmbeddedDocuments.GuidePages.Count + 1);
pages.Should().HaveCount(EmbeddedDocuments.GuidePages.Count + 2);
pages[0].Title.Should().Be("FrameLedger user guide");
pages.Take(EmbeddedDocuments.GuidePages.Count).Should().OnlyContain(static p => p.Text.Length > 300 && !p.Title.EndsWith(".md", StringComparison.Ordinal));
pages[^1].Path.Should().Be(LimitationsDocument.ResourceName);
pages[^2].Path.Should().Be(LimitationsDocument.ResourceName);
pages[^1].Path.Should().Be(AccessibilityDocument.ResourceName, "beta.35 (D88): the guide's links to the statement open in the window");
string[] onDisk = [.. Directory.EnumerateFiles(Path.Combine(RepoRoot(), "guide"), "*.md").Select(static f => "guide/" + Path.GetFileName(f)).Order(StringComparer.Ordinal)];
EmbeddedDocuments.GuidePages.Order(StringComparer.Ordinal).Should().Equal(onDisk, "a page in guide/ that the App does not list could never be read in the App");
@@ -110,10 +111,13 @@ public sealed class GuideDocumentsTests
{
if (!anchors.TryGetValue(target, out IReadOnlyDictionary<string, System.Windows.Documents.Block>? known))
{
bool limitations = string.Equals(target, LimitationsDocument.ResourceName, StringComparison.Ordinal);
string text = limitations ? LimitationsDocument.Load()
: target.StartsWith("guide/", StringComparison.Ordinal) ? EmbeddedDocuments.Read(target)
: File.ReadAllText(Path.Combine(root, target.Replace('/', Path.DirectorySeparatorChar)));
string text = target switch
{
LimitationsDocument.ResourceName => LimitationsDocument.Load(),
AccessibilityDocument.ResourceName => AccessibilityDocument.Load(),
_ when target.StartsWith("guide/", StringComparison.Ordinal) => EmbeddedDocuments.Read(target),
_ => File.ReadAllText(Path.Combine(root, target.Replace('/', Path.DirectorySeparatorChar))),
};
known = MarkdownRenderer.Render(text, target).Anchors;
anchors[target] = known;
}
@@ -112,7 +112,7 @@ public sealed partial class MarkdownRendererTests
text.Should().Contain(" 0. Definitions.").And.Contain(" # not a heading", "the GPL is not Markdown: its numbered sections are not a list");
}
/// <summary>Every embedded document — the Legal Gate's four and the Alpha notice (D74), LIMITATIONS, NOTICE, the trademark note, the third-party notices, the package index and the user guide's thirteen pages (eight until beta.17, twelve until beta.32).</summary>
/// <summary>Every embedded document — the Legal Gate's four and the Alpha notice (D74), LIMITATIONS, ACCESSIBILITY (beta.35, D88), NOTICE, the trademark note, the third-party notices, the package index and the user guide's thirteen pages (eight until beta.17, twelve until beta.32).</summary>
[Fact]
public async Task NothingAnyEmbeddedDocumentSaysIsDropped()
{
@@ -120,6 +120,7 @@ public sealed partial class MarkdownRendererTests
[
.. LegalDocuments.Load(Shared.BuildLine.Alpha).Select(static d => (d.Path, d.Text, d.IsPlainText)),
("LIMITATIONS.md", LimitationsDocument.Load(), false),
(AccessibilityDocument.ResourceName, AccessibilityDocument.Load(), false),
(EmbeddedDocuments.Notice, EmbeddedDocuments.Read(EmbeddedDocuments.Notice), true),
(EmbeddedDocuments.Trademarks, EmbeddedDocuments.Read(EmbeddedDocuments.Trademarks), false),
(EmbeddedDocuments.ThirdPartyNotices, EmbeddedDocuments.Read(EmbeddedDocuments.ThirdPartyNotices), false),
@@ -155,7 +156,7 @@ public sealed partial class MarkdownRendererTests
return problems;
});
documents.Should().HaveCount(23, "ten documents and the guide's thirteen pages");
documents.Should().HaveCount(24, "eleven documents and the guide's thirteen pages");
missing.Should().BeEmpty("the renderer must never shorten a document a user reads or accepts");
}
@@ -296,7 +296,7 @@ public sealed class ScrollBarHidingTests
}
/// <summary>A window shown where nobody sees it and never activated, small enough that the surfaces overflow it.</summary>
private static Window OffScreen(Window window)
internal static Window OffScreen(Window window)
{
window.Width = 1000;
window.Height = 420;
+10 -5
View File
@@ -5,7 +5,8 @@
<#
.SYNOPSIS
Builds the GitHub Wiki from the repository - wiki/ (Home, the sidebar, the developer pages), guide/ (the user
guide, which is the wiki's End-user part) and LIMITATIONS.md - and refuses a wiki with a link that leads nowhere.
guide, which is the wiki's End-user part), LIMITATIONS.md and ACCESSIBILITY.md - and refuses a wiki with a link that
leads nowhere.
.DESCRIPTION
D53/D54 (the owner, 2026-10-07): the wiki's source lives in the repository and the Wiki tab is a copy of it, written
@@ -15,7 +16,8 @@
Assembling:
- wiki/*.md keeps its file name, which GitHub turns into the page's title (Build-and-test.md: "Build and test").
- A guide page becomes the page its first heading names (guide/README.md is User-guide, LIMITATIONS.md is
Limitations). Every page's first heading is dropped: the wiki prints the page's name above it.
Limitations, ACCESSIBILITY.md - beta.35, D88 - is Accessibility). Every page's first heading is dropped: the wiki
prints the page's name above it.
- A link to one of those pages becomes the page's name; a link to any other file or folder of the repository
becomes its address on GitHub at -Ref, the release being published; anchors are kept.
- _Footer.md is written here, naming -Ref and where to edit.
@@ -43,9 +45,9 @@ Set-StrictMode -Version Latest
$ErrorActionPreference = 'Stop'
$repoUrl = 'https://github.com/poli0981/frameledger'
$special = @{ 'guide/README.md' = 'User-guide'; 'LIMITATIONS.md' = 'Limitations' }
$special = @{ 'guide/README.md' = 'User-guide'; 'LIMITATIONS.md' = 'Limitations'; 'ACCESSIBILITY.md' = 'Accessibility' }
$pathPrefixes = @('src/', 'docs/', 'tools/', 'tests/', 'guide/', 'legal/', 'wiki/', 'rules/', '.github/')
$rootFiles = @('README.md', 'CLAUDE.md', 'CHANGELOG.md', 'LIMITATIONS.md', 'CONTRIBUTING.md', 'FORKING.md', 'SECURITY.md',
$rootFiles = @('README.md', 'CLAUDE.md', 'CHANGELOG.md', 'LIMITATIONS.md', 'ACCESSIBILITY.md', 'CONTRIBUTING.md', 'FORKING.md', 'SECURITY.md',
'CODE_OF_CONDUCT.md', 'NOTICE', 'LICENSE', 'VERSION', 'build.ps1', 'global.json', 'FrameLedger.slnx', 'Directory.Build.props')
if ($Ref -notmatch '^[A-Za-z0-9][A-Za-z0-9._/-]*$') { throw "-Ref '$Ref' is not a branch, tag or commit name" }
@@ -103,6 +105,7 @@ function Get-Sources([string]$SourceRoot) {
foreach ($f in Get-ChildItem (Join-Path $SourceRoot 'wiki') -Filter *.md -File | Sort-Object Name) { & $add "wiki/$($f.Name)" $f.FullName }
foreach ($f in Get-ChildItem (Join-Path $SourceRoot 'guide') -Filter *.md -File | Sort-Object Name) { & $add "guide/$($f.Name)" $f.FullName }
& $add 'LIMITATIONS.md' (Join-Path $SourceRoot 'LIMITATIONS.md')
& $add 'ACCESSIBILITY.md' (Join-Path $SourceRoot 'ACCESSIBILITY.md')
return , $sources
}
@@ -281,6 +284,7 @@ if ($SelfTest) {
Copy-Item (Join-Path $RepoRoot 'wiki') (Join-Path $tmp 'wiki') -Recurse
Copy-Item (Join-Path $RepoRoot 'guide') (Join-Path $tmp 'guide') -Recurse
Copy-Item (Join-Path $RepoRoot 'LIMITATIONS.md') $tmp
Copy-Item (Join-Path $RepoRoot 'ACCESSIBILITY.md') $tmp
$cases = 0
$expect = {
param([string]$What, [string]$Pattern)
@@ -306,6 +310,7 @@ if ($SelfTest) {
& $mutate 'wiki/Home.md' { param($t) $t + "`n[gone](../guide/01-install.md#no-such-section)`n" } 'a link to a missing section' 'no-such-section.*names no section'
& $mutate 'wiki/Home.md' { param($t) $t + "`n[out](../../outside.md)`n" } 'a link out of the repository' 'leaves the repository'
& $mutate 'wiki/Limitations.md' { param($t) "Same name as LIMITATIONS.md.`n" } 'two sources for one page' "both make the page 'Limitations'"
& $mutate 'wiki/Accessibility.md' { param($t) "Same name as ACCESSIBILITY.md.`n" } 'two sources for the statement''s page' "both make the page 'Accessibility'"
& $mutate 'wiki/Orphan.md' { param($t) "Nothing links here.`n" } 'a page nothing leads to' "leads to 'Orphan'"
& $mutate 'wiki/_Sidebar.md' { param($t) ($t -replace '(?m)^- \[Questions and answers\]\(\.\./guide/06-faq\.md\)\r?\n', '') + "- [Questions and answers](../guide/06-faq.md)`n" } 'a sidebar out of the guide''s order' 'lists the guide as'
& $mutate 'wiki/Home.md' { param($t) $t + "`nSee ``src/FrameLedger.App/NoSuchFile.cs``.`n" } 'a backticked path that names nothing' 'NoSuchFile\.cs.*names nothing'
@@ -322,7 +327,7 @@ $result = Invoke-Assembly $RepoRoot $RepoRoot $Ref
if ($result.Problems.Count -ne 0) {
Write-Host 'WIKI CHECK FAILED:' -ForegroundColor Red
foreach ($p in $result.Problems) { Write-Host " $p" -ForegroundColor Red }
Write-Host ' The wiki is built from wiki/, guide/ and LIMITATIONS.md (docs/13_CI_CD.md, wiki.yml).' -ForegroundColor Red
Write-Host ' The wiki is built from wiki/, guide/, LIMITATIONS.md and ACCESSIBILITY.md (docs/13_CI_CD.md, wiki.yml).' -ForegroundColor Red
exit 1
}
if ($Check) {
+4
View File
@@ -58,3 +58,7 @@ Each of these cost a release; the full list, with the tests that hold each, is
(`PagesLoadTests.OnStaAsync`): contrast in both themes, a theme switch while a surface is on screen, scroll bars with the
option on in a real window, keyboard and automation names. Each surface is hosted as the App hosts it — a page in WPF UI's
navigation presenter, not straight in a window. A rendered check is run red against the unfixed XAML first.
What the App promises a user of the keyboard, a screen reader or a contrast theme is
[`ACCESSIBILITY.md`](../ACCESSIBILITY.md); the design and the checks that hold it are §Accessibility of
[`docs/08_UI.md`](../docs/08_UI.md#accessibility). A change that moves one changes both.
+3
View File
@@ -48,5 +48,8 @@ The checklist is [`.github/pull_request_template.md`](../.github/pull_request_te
- A change to the hook layer states its measured overhead, lists any new hook in the inventory
([`docs/17_HOOK_ENGINE.md`](../docs/17_HOOK_ENGINE.md)) and answers the safety review questions in the template.
- A user-visible limit that moves updates [`LIMITATIONS.md`](../LIMITATIONS.md) in the same pull request.
- A change to what the App shows keeps [`ACCESSIBILITY.md`](../ACCESSIBILITY.md#for-contributors) — a name for every
control that shows no text, theme colours only, nothing shown by colour alone, everything reachable by keyboard — says
in the pull request what was checked with the keyboard and Narrator, and updates the page when what works moves.
How to contribute and how contributions are licensed: [`CONTRIBUTING.md`](../CONTRIBUTING.md).
+5 -3
View File
@@ -20,8 +20,9 @@ The [user guide](../guide/README.md) is the one FrameLedger shows under Help ▸
To look something up: [The screens](../guide/07-screens.md), [Every setting](../guide/08-settings.md),
[When something goes wrong](../guide/09-troubleshooting.md), [Words FrameLedger uses](../guide/10-glossary.md),
[The terms, in plain words](../guide/terms-in-plain-words.md), and [Limitations](../LIMITATIONS.md) — what FrameLedger
cannot do.
[The terms, in plain words](../guide/terms-in-plain-words.md), [Limitations](../LIMITATIONS.md) — what FrameLedger
cannot do — and [Accessibility](../ACCESSIBILITY.md): what works with the keyboard alone, a screen reader or a contrast
theme, and how to report a barrier.
## Build or change FrameLedger
@@ -38,6 +39,7 @@ document in [`docs/`](../docs/README.md).
## More
- A bug or a question: the project's [issues](https://github.com/poli0981/frameledger/issues). A game whose anti-cheat
FrameLedger missed: the **Safety gap** form there.
FrameLedger missed: the **Safety gap** form there. Something that cannot be reached, read or seen: the
**Accessibility problem** form.
- A vulnerability: [`SECURITY.md`](../SECURITY.md).
- The licence: [`LICENSE`](../LICENSE) (GPL v3) and [`NOTICE`](../NOTICE); the name: [`legal/TRADEMARKS.md`](../legal/TRADEMARKS.md).
+3 -2
View File
@@ -17,7 +17,8 @@ The full documents are [`docs/13_CI_CD.md`](../docs/13_CI_CD.md) and [`docs/11_U
1. One pull request moves the `[Unreleased]` entries of [`CHANGELOG.md`](../CHANGELOG.md) into a new file,
`docs/changelog/<version>.md`, under a `## [x.y.z]` or `## [x.y.z-beta.N]` heading with an *Updating from* note,
adds its row to the Releases table in `CHANGELOG.md`, and updates the release lines in `README.md`, the accuracy
statement (`legal/ACCURACY.md` and its copies) and `LIMITATIONS.md`. `VERSION` changes only with the numeric core.
statement (`legal/ACCURACY.md` and its copies), `LIMITATIONS.md` and `ACCESSIBILITY.md`. `VERSION` changes only with
the numeric core.
2. After it merges, a signed tag `vx.y.z` (or `vx.y.z-beta.N`) on the merge commit starts `release.yml`:
- it checks the tag against `VERSION` and that the changelog has the section;
- reads the build id from the clean checkout, before anything is edited;
@@ -41,7 +42,7 @@ follows each beta, never several in a row ([`docs/13_CI_CD.md`](../docs/13_CI_CD
1. A pull request on `main` adds the alpha's notes, `docs/changelog/<version>.md`, opening with the experimental-build
warning and naming the beta it is cut from, and its row in the Releases table. No release line moves: README, the
accuracy statement and `LIMITATIONS.md` keep naming the beta.
accuracy statement, `LIMITATIONS.md` and `ACCESSIBILITY.md` keep naming the beta.
2. A pull request merges `main` into `alpha` with a merge commit; CI runs the gate there on the prerelease SDK.
3. A rehearsal of `release.yml` on `alpha`, then a signed tag `vx.y.z-alpha.N` on its head. The workflow refuses any
other tag on that branch, and an alpha's tag anywhere else; it packs on Velopack's `alpha` channel, so no beta is
+1
View File
@@ -43,3 +43,4 @@ Dependencies point inwards: App and Agent → Application → Domain; Infrastruc
| `legal/` | The documents a user accepts, the accuracy statement, licences and notices. |
| `.github/workflows/` | CI, CodeQL, the rules gate, the release and the wiki. |
| `LIMITATIONS.md` | What the whole software cannot do, in a player's words; also in the App. |
| `ACCESSIBILITY.md` | The accessibility statement: the goal, what works, the known limits, how a barrier is reported; also in the App. |
+1
View File
@@ -16,6 +16,7 @@
- [Alpha builds](../guide/11-alpha-builds.md)
- [The terms, in plain words](../guide/terms-in-plain-words.md)
- [Limitations](../LIMITATIONS.md)
- [Accessibility](../ACCESSIBILITY.md)
**Build or change FrameLedger**