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

Add a tutorial section to the page #48

Merged
merged 3 commits into from
Oct 5, 2023

Conversation

tmadlener
Copy link
Contributor

@tmadlener tmadlener commented Sep 29, 2023

BEGINRELEASENOTES

  • Add a tutorial section to the page.
  • Move existing starterkit documentation into the tutorials section

ENDRELEASENOTES

@jmcarcell @andresailer @gaede as discussed I added a tutorial section to the page. Currently there is an empty "example" tutorial just to demonstrate the layout in the end.
This looks like this in the current page:
image

I will start to add the converter tutorial to this in a separate PR. I think we could potentially merge this first (or at least everyone can start from here). For adding a new tutorial you simply need to add the markdown or rst file into the eval_rst block in the README.md.

@tmadlener
Copy link
Contributor Author

tmadlener commented Sep 29, 2023

I have realized that we already have quite a bit of tutorial style content on the page, so I have effectively just shuffled that into the Key4hep Tutorials category. I had to adapt the fetch_external_sources.sh script slightly to not only work on the toplevel README.md. This still allows us to put content into this repository but also fetches external content from others, so we don't have to duplicate things.

It now looks like this:

image

@tmadlener
Copy link
Contributor Author

@jmcarcell @andresailer anything against merging this so that we can continue on top of this for the Paestum tutorial?

@jmcarcell
Copy link
Member

I think this is fine

@jmcarcell jmcarcell merged commit 32f2764 into key4hep:main Oct 5, 2023
1 check passed
@tmadlener tmadlener deleted the add-tutorials branch October 5, 2023 07:32
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.

2 participants