Skip to content

QASight docs

Design notes for QASight (qasight, CLI qasight). New here? Getting Started adds it to your project in about five minutes. For the design, start with ARCHITECTURE.md and README.md.

The notes are plain markdown. They open as an Obsidian vault, and are published as a searchable site at https://arieleven.github.io/qasight/docs/. Dated plans, audits and phase checklists from earlier development are in the Archive.

Architecture

Using the CLI

  • Getting Started: install, write qasight.yaml, run a cycle, see what changed, run it in GitHub Actions
  • Compared With Other Tools: where QASight fits next to Allure, ReportPortal, Currents, Trunk and Datadog, and when to pick one of them instead
  • Setup Prompts: copy-paste prompts for an AI assistant to install QASight in your project, write qasight.yaml, add CI and open the UI
  • Command Reference: every qasight command, flag and exit code, and the qasight.yaml schema
  • Troubleshooting and Error Codes: exit codes, NDJSON errors, debugging playbook

Testing and CI

  • QA Strategies: how runs are defined, triggered, logged, and how the orchestrator tests itself
  • Setup Snippets: copy-paste CI setup for each runner (pytest, Jest, Vitest, Playwright, Go, .NET, Maven, Gradle, RSpec, PHPUnit) on GitHub Actions, GitLab CI, Jenkins and CircleCI, no config file needed
  • CI-CD Pipeline Setup: GitHub Action, GitLab template, runner image, test tiers
  • Team Server: one shared history for every CI job, with qasight ingest --server, the UI and Postgres in Docker
  • Shared Resource Pools: give each parallel worker its own VM, device or test account with qasight lease, safely across laptops
  • E2E Harness Operations Guide: the external E2E harness
  • GitLab Pages Demo: the GitHub and GitLab Pages demo pipeline

Releasing

Decisions and direction

  • Specs & ADRs: design decisions that still describe the code
  • Product Roadmap: current state and next steps
  • Technical Debt Tracker: open backlog
  • Project Review: whole-repo scorecard (architecture, code, tests, security, docs, CI) and verdict, 2026-10-24
  • Architecture Review: ranked review of module boundaries, data model, scaling limits and extension points, with proposed next steps, 2026-10-31
  • Better Flaky Signal: flaky means passed on retry, mixed results on one commit, or flips on one branch; broken tests kept apart, 2026-11-01
  • Quarantine From the UI: a Quarantine button and qasight quarantine, a list the server keeps, applied to qasight run, qasight ingest and pytest --qasight, released after clean runs, 2026-11-01
  • Importer and Integration Bug Hunt: ranked bugs found by feeding the importers malformed and real-tool reports, and in the Action, PR comment, alerts, OTel, affected selection and plugins, with fixes and proposals, 2026-10-31
  • Product Review: product scorecard (positioning against Allure, ReportPortal, Currents and Trunk, onboarding, the red-build workflow, design, accessibility, copy) and the Now / Next / Later roadmap, 2026-10-24
  • Feature Gaps and Quick Wins: what paid flaky-test and test-analytics tools do that QASight doesn't yet, ranked with effort, and the bugs a new user hits in the first ten minutes, 2026-10-31
  • New User Journey Audit: every step from finding QASight to running it for a team, what is still done by hand, and ranked proposals to automate it, 2026-11-01
  • Paid Features to Offer Free: which features competitors keep behind paid plans, the ones QASight could give away self-hosted, ranked, and the licence and trademark rules for copying ideas, 2026-10-31
  • UI Design Review: the web UI as a piece of design (hierarchy, consistency, copy, charts, states, accessibility), ranked findings with annotated screenshots, 2026-10-31
  • Engineering Health Review: test suite, CI, docs accuracy and dependencies (flaky tests, Dependabot, TypeScript 7), what was fixed and ranked proposals, 2026-10-31
  • UI Review Fixes: what was built from the review's proposals (cycle results on the Cycles grid, run labels with time and branch, the Compare test list under the summary, test page charts, quieter cards), 2026-11-01
  • Engine and CLI Bug Hunt: reproduced bugs in qasight, config parsing, the engine, storage and the importers, what was fixed, and ranked proposals for the rest, 2026-10-31
  • Agent Context Guide: which note to read before changing what (for AI coding agents)

The vault itself

  • Vault schema: frontmatter, linking and the ingest / query / lint rules for these notes
  • Vault log: record of changes to the vault's structure