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

Update docs to spread knowledge #150

Open
DominicOram opened this issue Nov 23, 2023 · 0 comments
Open

Update docs to spread knowledge #150

DominicOram opened this issue Nov 23, 2023 · 0 comments

Comments

@DominicOram
Copy link
Collaborator

As discussed with @graeme-winter, @noemifrisina, @dperl-dls and myself, we need to spread the knowledge of how nexgen works and what it does. There are already some docs, this is a list of improvements for them.

Nexgen is currently being used for some specific applications at beamlines I19-2 and I24 at DLS.

This doesn't mention Hyperion, ED or how their use differs between each beamline

I think it would be good to have some specific mentions of if each beamline uses the CLI etc.

The autogenerated docs are good for individual parts of the code but don't give a high level view. It would be good to write some kind of code map https://github.com/DiamondLightSource/hyperion/wiki/Code-Map for how to navigate the codebase.

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

No branches or pull requests

1 participant