Skip to content

AGENTS.md: cookbook pointer and StatusPalette colour rule - #63

Merged
seb5g merged 1 commit into
5.3.xfrom
docs/agents-status-cookbook
Oct 26, 2026
Merged

seb5g merged 1 commit into
5.3.xfrom
docs/agents-status-cookbook

Conversation

@seb5g

@seb5g seb5g commented Oct 25, 2026

Copy link
Copy Markdown
Contributor

Before: the template AGENTS.md told plugin authors to put the hardware communication in hardware/ but not where to find a working example for their kind of instrument, and said nothing about the colours of status indicators.

After: it points to the matching recipe of the cookbook of pymodaq_plugins_mockexamples (pymeasure, serial, VISA, ctypes DLL, pythonnet assembly, camera, spectrometer), and the Dashboard extension rules state that LEDs and icons take their colours from StatusPalette / Status, with the same wording as the PyMoDAQ AGENTS.md.

What changes: one bullet in the "Instrument plugins" rules and one in the "Dashboard extensions" rules.

How: StatusPalette is in pymodaq_gui since 5.3.0 (the floor of the template). The recipes are the ones merged in pymodaq_plugins_mockexamples (PRs 24 to 27). The pointer to the "Plugin cookbook" docs page refers to PyMoDAQ PR 1419, which is not merged yet.


Generated by Claude Code

…colour rule

Hardware communication: copy the matching recipe of pymodaq_plugins_mockexamples. Dashboard extensions: LEDs and icons
take their colours from StatusPalette, as stated in the PyMoDAQ AGENTS.md.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Tdiso1u1ZhikSutj2Qs5Cg
@seb5g
seb5g merged commit af69807 into 5.3.x Oct 26, 2026
8 checks passed
@seb5g
seb5g deleted the docs/agents-status-cookbook branch October 26, 2026 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants