DiamondLightSource / DiamondLightSource/dodal

Create a device catalogue

Open
#1,076 4 comments 0 reactions 1 assignee Assigned to @DiamondJoseph View on GitHub
Docsathon documentation
Dominant language
Python
Stars
5
Forks
13
Avg merge
3d 2h
Merged PRs (30d)
10

Description

As more groups across DLS are starting to use dodal, it will be very useful to have an organised list of all the common devices, along with a simple description of how that device is used in a beamline (from a hardware perspective).

Once a few of these have been written, I think we should start to ask that PR's adding new devices must also come with a new catalogue entry (open to discussion on this part)

We should create sub-issues to add individual devices to the catalogue

## Acceptance Criteria
- Device catalogue created, containing entries for the most commonly-used devices
- Document that when adding a new device, you should also add an entry to the device catalogue

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.