diff --git a/.github/AGENTS.md b/.github/AGENTS.md new file mode 100644 index 0000000..9afa87f --- /dev/null +++ b/.github/AGENTS.md @@ -0,0 +1,120 @@ +# robotframework-dashboard — Agent Guide + +This file gives AI agents and contributors the context needed to work effectively in this codebase. + +--- + +## 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 +``` + +This block replaces `` in `templates/dashboard.html`. + +--- + +## How CSS Is Bundled + +`DependencyProcessor._inline_css_files()` reads all `.css` files under `robotframework_dashboard/css/` in sorted order (`base.css`, `colors.css`, `components.css`, `dark.css`) and concatenates them into a single `