Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added more documentation #107

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added more documentation #107

wants to merge 1 commit into from

Conversation

rosesyrett
Copy link
Collaborator

No description provided.

@rosesyrett
Copy link
Collaborator Author

as there is currently no support for tango, I think I need to mention this somewhere at a top level. Otherwise it gets annoying having to write everywhere that you could do this with a tango layer instead of epics.

I'll do this next week.

@DiamondJoseph
Copy link
Contributor

Move code samples into epics.demo or similar. Make sure the words make sense. TODO by me.

@@ -0,0 +1,216 @@
Create Detectors
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recommend renaming this to Support Various Detectors and adding a line at the start explaining, for new people, that detectors all have shared functionality but behave in subtly different ways and this article explains how to compose various components in different ways to support different ones. If I were a new starter reading this I'd be wondering why it's so complicated, so I think it would be good to convey that from the start.

Comment on lines +9 to +10
A StandardDetector needs two crucial components; a `DetectorControl` object and
a `DetectorWriter`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could allude to the driver here as well?

@coretl
Copy link
Collaborator

coretl commented Apr 24, 2024

@callumforrester is any of this worth adding to the current docs after your additions?

@callumforrester
Copy link
Contributor

@coretl Will review and get back to you

@stan-dot stan-dot added documentation Improvements or additions to documentation Developer Experience labels Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Developer Experience documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants