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 documentation #145

Merged
merged 10 commits into from
Nov 7, 2024
Merged

Update documentation #145

merged 10 commits into from
Nov 7, 2024

Conversation

gipert
Copy link
Member

@gipert gipert commented Nov 5, 2024

No description provided.

docs/index.rst Outdated Show resolved Hide resolved
@gipert
Copy link
Member Author

gipert commented Nov 5, 2024

I started with the tutorial (but want to add much more in the next days), please have a look.

@ManuelHu @tdixon97

docs/tutorial.md Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
@gipert
Copy link
Member Author

gipert commented Nov 6, 2024

I think this looks better now. Anything else crucial I should include?

@gipert gipert marked this pull request as ready for review November 6, 2024 21:56
@ManuelHu
Copy link
Collaborator

ManuelHu commented Nov 6, 2024

Maybe we should use a less confusing (i.e. more useful in the field of particle detectors) material for the source volume?

Apart from that it already looks very good :-)

@tdixon97
Copy link

tdixon97 commented Nov 7, 2024

I like the source material

@gipert
Copy link
Member Author

gipert commented Nov 7, 2024

Trying to fix #149 but it's a bit flaky, it does not recognize parameter description fields yet...

@ManuelHu
Copy link
Collaborator

ManuelHu commented Nov 7, 2024

maybe we should move this to a seperate PR?

@ManuelHu ManuelHu mentioned this pull request Nov 7, 2024
@gipert gipert added the documentation Improvements or additions to documentation label Nov 7, 2024
@ManuelHu ManuelHu merged commit f586fea into main Nov 7, 2024
10 checks passed
@ManuelHu ManuelHu deleted the docs branch November 7, 2024 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants