Skip to content

Tweaks to create accelerator tutorial - #52

Open
TeresiaOlsson wants to merge 1 commit into
docs/intro-structure-configurationfrom
docs/create-accelerator
Open

TeresiaOlsson wants to merge 1 commit into
docs/intro-structure-configurationfrom
docs/create-accelerator

Conversation

@TeresiaOlsson

Copy link
Copy Markdown
Member

I made some changes to the create accelerator tutorial.

  • Move the explanation of the test lattice to a separate page to prepare for having a separate documentation in that repository. The link can just be updated to that then.
  • Added a box around the configuration role to highlight it
  • Removed some parts to make less text to read

@GamelinAl

Copy link
Copy Markdown
Member

I am not sure about having the test lattice presentation in explanation.
For me it's really needed for the user to understand quickly what is this lattice.
We can have a more detailed presentation somewhere if you wish but I would like to keep this small lattice presentation in one of the 1st tutorial notebooks.

@TeresiaOlsson

Copy link
Copy Markdown
Member Author

I am not sure about having the test lattice presentation in explanation. For me it's really needed for the user to understand quickly what is this lattice. We can have a more detailed presentation somewhere if you wish but I would like to keep this small lattice presentation in one of the 1st tutorial notebooks.

Okay, I understand what you mean. I moved it because I felt this tutorial was very dense with content and it took focus away from what the tutorial was focusing on. It felt to me like I was expecting to learn how to create an accelerator but instead I was reading details about a lattice. But I agree that a link is not so good because it means the user won't understand unless they click on it and then they are suddenly on a different page and can get side-tracked.

Maybe since the test lattice is used for all tutorials the explanation can go in the introduction tutorial? There it doesn't take focus away because the focus of the reader is to understand all the background needed for the tutorials.

@GamelinAl

Copy link
Copy Markdown
Member

Maybe since the test lattice is used for all tutorials the explanation can go in the introduction tutorial? There it doesn't take focus away because the focus of the reader is to understand all the background needed for the tutorials.

It's an option I would be ok with but not the best I think. Ideally you would want the user to get the information he needs, just before he needs it.

@TeresiaOlsson

Copy link
Copy Markdown
Member Author

Maybe since the test lattice is used for all tutorials the explanation can go in the introduction tutorial? There it doesn't take focus away because the focus of the reader is to understand all the background needed for the tutorials.

It's an option I would be ok with but not the best I think. Ideally you would want the user to get the information he needs, just before he needs it.

Okay, I see your point. Let's see how it works with it. I also reduced the content at the end of the tutorial so maybe it's not too dense anymore.

This branch has not been deployed

No deployments
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