Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 3.7 KB

README.md

File metadata and controls

39 lines (30 loc) · 3.7 KB

Documentation

This directory documents the current AdBlocker Test Lab repository and the two supplied historical attachments. It is written for maintainers, reviewers, and future implementers.

Documentation map

Document Purpose Authority
Current system Runtime architecture, source layout, state, execution, and exports Current source code
Measurement and scoring Test taxonomy, evidence model, classification, and score rules Current source code
Operations and deployment Local workflow, deployment checklist, configuration, and ad-integration boundary Current source code and repository documentation
Known limitations and roadmap Proven limitations, risks, and sequenced work Current source code plus clearly labelled recommendations
Attachment review Detailed record of the supplied Canvas/proposal discussion and what remains reference-only Supplied attachments
Product requirements document Product purpose, users, functional requirements, success criteria, and non-goals Current source and accepted product direction
Technical requirements document Target architecture, interfaces, data rules, security constraints, and implementation requirements Current source and planned requirements
UI and UX specification Information architecture, interaction behavior, accessibility, responsive rules, and UI acceptance criteria Current UI and planned requirements
Technology stack Current dependencies, build pipeline, hosting assumptions, and adoption rules Current package/configuration files
Design rationale UI audit, design read, and deliberate visual decisions Current source and approved redesign direction
Quality and release strategy Test layers, release gates, evidence capture, and ownership checklist Current validation and planned requirements
Engineering log Append-only record of implemented changes, verification, and deployment status Verified repository activity

Source-of-truth rules

  1. Current checked-in source and runtime verification override historical notes.
  2. A browser observation is not automatically attribution to a specific ad blocker, DNS service, VPN, or browser setting.
  3. Controlled first-party fixtures, exploratory third-party probes, and browser capability checks have different evidentiary value and must not be conflated.
  4. No documentation claim about ads, deployment, publisher approval, or cross-browser behavior is evidence of approval or production operation.

Current snapshot

  • Product: AdBlocker Test Lab, version 4.1.0.
  • Runtime: a Vite + React single-page application.
  • Registry: 55 test entries across 14 sections: 35 core ad/tracker-blocking cases, 9 privacy signals, and 11 exploratory probes. All displayed group counts derive from the registry.
  • The 0–100 score includes only eligible core ad/tracker-blocking results. Privacy signals and exploratory probes are reported separately and cannot increase that score.
  • Current validation: strict TypeScript check, production Vite build, production dependency audit, browser smoke test, and all 15 in-app assertions must pass for a release.

How to update these documents

Update the relevant document in the same change as any new test type, result state, score rule, fixture endpoint, export field, publisher integration, or deployment process. Re-run the commands in Operations and Deployment and do not describe an unverified behavior as working.