Skip to content

Add basic docs #97

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

Merged
merged 5 commits into from
Jun 27, 2025
Merged

Add basic docs #97

merged 5 commits into from
Jun 27, 2025

Conversation

olliesilvester
Copy link
Collaborator

@olliesilvester olliesilvester commented Jun 9, 2025

Fixes #68

Also it would be good to add more specific instructions for how to add sealed secrets to your beamline cluster

To test:

  • In the devcontainer, run tox -e docs autobuild
  • Read the docs, test the links, check grammar etc

@olliesilvester olliesilvester marked this pull request as ready for review June 26, 2025 09:58
Copy link
Collaborator

@Relm-Arrowny Relm-Arrowny left a comment

Choose a reason for hiding this comment

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

I have spotted a few typo but It looks ok to me, you may want someone with a fresh pair of eyes to check it.

Copy link
Collaborator

@Relm-Arrowny Relm-Arrowny left a comment

Choose a reason for hiding this comment

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

Look good and sensible to me., Thanks.

@olliesilvester olliesilvester merged commit 29d8714 into main Jun 27, 2025
21 checks passed
@olliesilvester olliesilvester deleted the 68_write_docs branch June 27, 2025 10:16
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.

Write basic documentation
2 participants