From 38b9fc59cfbff6d8b5a9a60154cf6fb5f86966e0 Mon Sep 17 00:00:00 2001 From: Tim de Groot Date: Sun, 14 Jun 2026 23:45:40 +0200 Subject: [PATCH 1/5] docs: add CLAUDE.md project instructions for AI agents Provides AI agents with context on the pipeline architecture, entry points, and pointers to the .github/skills/ domain-specific guides. --- CLAUDE.md | 135 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 135 insertions(+) create mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 00000000..b14b0dce --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,135 @@ +# robotframework-dashboard — Copilot Instructions + +This file gives AI agents and contributors the context needed to work effectively in this codebase. + +## How to Use the Skills Files + +Before starting work on any non-trivial task, read the relevant skill file from `.github/skills/`. Each file contains deep domain knowledge that avoids re-exploring the codebase from scratch. Use the table in the **Skills** section below to pick the right one(s). Read the skill file with a file-read tool before making any changes. + +--- + +## Project Purpose + +`robotframework-dashboard` is a Python CLI tool that reads Robot Framework `output.xml` execution results, stores them in a SQLite database, and generates a fully self-contained HTML dashboard with interactive charts, tables, and filters. No web server is required to view the output — a single `.html` file contains all data, JS, and CSS. + +--- + +## Core Pipeline: Python CLI → HTML Template → JavaScript + +The entire system is this three-stage pipeline: + +``` +1. PYTHON CLI + output.xml files + └─► OutputProcessor (robot.api ResultVisitor) + └─► SQLite database (runs / suites / tests / keywords tables) + +2. HTML TEMPLATE + database.get_data() + └─► DashboardGenerator + ├─► DependencyProcessor: merges all JS modules (topological sort) → inline