MarketSquare/robotframework-dashboard

coding-standards

Naming, structure, and style rules for Python, JavaScript, HTML, and CSS in this repo, plus how the existing JavaScript is organised (module layout, where variables live, function naming, localStorage, GridStack, Chart.js conventions). Use when writing or…

Langue du texte source : anglais

js-bundling

How Python's DependencyProcessor bundles JS/CSS into the single HTML (import graph, topo sort), CDN vs offline libraries, zlib+base64 data. Use when adding a JS/CSS file, upgrading a library, or a module is missing from the HTML.

Langue du texte source : anglais

server-api

The optional FastAPI server (--server): every REST endpoint, HTTP Basic Auth on /admin and the mutating endpoints, log linking (/add-log, /log), auto-update behaviour, and the admin page bundle. Use when adding or changing endpoints, debugging uploads from…

Langue du texte source : anglais

add-cli-argument

Checklist for adding, renaming or deprecating a robotdashboard CLI flag ("add a --flag", "new CLI option"): arguments.py, validation, wiring, server/listener parity, unit + 00_cli.robot tests, help.txt snapshot, docs.

Langue du texte source : anglais

dashboard-graphs

Dashboard pages, Chart.js architecture, which graph_data/graph_creation module owns each graph, and the checklist for adding a graph. Use when adding or changing a graph, chart type, tooltip, or page section.

Langue du texte source : anglais

filtering-and-settings

Filter modal and pipeline (runs, run tags, dates, metadata, versions, profiles), overview→dashboard pre-filters, settings + localStorage, JSON config, GridStack layout editor. Use for any filter, settings toggle, or saved layout task.

Langue du texte source : anglais

release

Step-by-step release procedure: bump version.py and setup.py, update the CLI version fixture, regenerate example/robot_dashboard.html and example/robot_results.db, write the CHANGELOG entry, and produce Slack release notes. Use when the user says "do the…

Langue du texte source : anglais

testing

Run, add, debug or fix Robot (Docker, Playwright screenshots, pabot), Python (pytest) or JS (Vitest) tests. Use whenever a task mentions tests, test failures, red CI, reference screenshots, or end-to-end verification.

Langue du texte source : anglais

js-features

End-to-end checklist for adding a front-end feature — new widget types, GridStack tiles, localStorage-persisted data (merge_deep/merge_layout whitelists), undo/redo snapshots, modal dialogs, and the layout-user-action event. Use when implementing a new…

Langue du texte source : anglais

dev-workflow

Run the robotdashboard CLI from source without installing, regenerate and validate the dashboard HTML after JS/CSS/template/Python changes, start the FastAPI server, or build/preview the VitePress docs site. Use for any "try it locally", "generate a…

Langue du texte source : anglais

documentation

Where user-facing documentation lives (docs/ VitePress site, README.md, CONTRIBUTING.md, setup.py long_description), the docs page map, and the checklist for keeping them in sync. Use whenever a CLI flag, filter, setting, graph, server endpoint, or other…

Langue du texte source : anglais

gh-issue

Work a GitHub issue end to end with the gh CLI — fetch the issue, branch, find the root cause, fix it, add a regression test, run the tests, self-review, then stop and report before committing. Use when the user says "work on gh issue N", "fix issue N", "look…

Langue du texte source : anglais

listener-integration

The Robot Framework listener (robotframework_dashboard.robotdashboardlistener) and standalone push script that upload output.xml/log.html to the dashboard server after a run: all listener arguments, pabot/RobotCode usage, and which server endpoints get…

Langue du texte source : anglais