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

Optimize tutorial notebooks for online display #356

Closed
PSSF23 opened this issue Nov 5, 2020 · 8 comments · Fixed by #371
Closed

Optimize tutorial notebooks for online display #356

PSSF23 opened this issue Nov 5, 2020 · 8 comments · Fixed by #371
Assignees

Comments

@PSSF23
Copy link
Member

PSSF23 commented Nov 5, 2020

My issue is about making sure all tutorials are displayed correctly on netlify-produced website. Even if the tutorial notebooks are displayed correctly on GitHub or local host, they might show nonsense equations and uninformative titles online.

Some guidelines:

  • Use label_shuffle_exp tutorial as an example. Everything displays correctly on its website.
  • Format the first markdown line with "#" at front and make it the one and only informative title instead of "overview" or other terms.
  • Format the subtitles with "##" at front so that they will show up as submenus on website.
  • Check the netlify preview for your PR, which is included as one of the required checks.

Snapshot of documentation error:

Screen Shot 2020-11-05 at 13 04 36

@PSSF23
Copy link
Member Author

PSSF23 commented Nov 5, 2020

If employing the website now with staging branch, we will have at least 3 tutorial pages named "Tutorial Overview." Do you mind reformat them in a more informative way? @bstraus1

@bstraus1
Copy link
Contributor

bstraus1 commented Nov 5, 2020

Can you elaborate on what you’d like me to do exactly about the redundant titles?

@PSSF23
Copy link
Member Author

PSSF23 commented Nov 5, 2020

@bstraus1 Use the "#" format once and only on the true title I suppose? Like:

Installation Guide

@levinwil
Copy link
Collaborator

@PSSF23 What is the status of this issue? Is there anything else to update? I haven't been following very closely.

@PSSF23
Copy link
Member Author

PSSF23 commented Nov 17, 2020

@levinwil Current tutorials should be addressed already, but I want to keep it open as a reference. New notebooks keep coming~

@PSSF23 PSSF23 self-assigned this Nov 17, 2020
@levinwil
Copy link
Collaborator

@PSSF23 We could just make a wiki page. I think that would be more appropriate as a guide. Or we could add this to the contribution guidelines. I think issues should be concrete tasks that can be closed once finished - but it doesn't seem like this has a concrete end-point.

@PSSF23
Copy link
Member Author

PSSF23 commented Nov 17, 2020

@levinwil adding to contribution guideline is a good idea. I will start working on it and close the issue when the guideline is updated.

@levinwil
Copy link
Collaborator

@PSSF23 Sounds good :)

@PSSF23 PSSF23 linked a pull request Nov 17, 2020 that will close this issue
@PSSF23 PSSF23 closed this as completed Nov 17, 2020
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 a pull request may close this issue.

3 participants