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

webpage (tutorial/documentation/etc.) pipeline improvements #278

Closed
Roger-luo opened this issue May 2, 2021 · 3 comments
Closed

webpage (tutorial/documentation/etc.) pipeline improvements #278

Roger-luo opened this issue May 2, 2021 · 3 comments
Labels
docs need to do with documentation unitaryhack

Comments

@Roger-luo
Copy link
Member

Roger-luo commented May 2, 2021

This issue has been tagged for a bounty during #unitaryHACK

This issue is for tracking the web page related problems

Layouts

  1. we need a more consistent solution to add banners to pages, see also (Documenter/#1132)
  2. improve large screen experience (Documenter/#1563)
  3. improve CSS to have a more consistent style.

Tutorial

  1. our Pluto tutorial is included via <iframe> which has a delay and bad layout, unlike the previous tutorials based Literate.jl, we don't have an easy to download button at the moment
  2. the tutorial page table of content (the left panel) has an inconsistent layout with the banner

Pipeline

ideally, we should move all documentation into one repo, and build them together, like DiffEq documentation, this requires

  1. a CI that gets triggered (or a nightly cron job) for the master branch to rebuild new documentation parts for each component packages
  2. integration with the front page
@Roger-luo Roger-luo added docs need to do with documentation unitaryhack labels May 2, 2021
@Roger-luo
Copy link
Member Author

@fonsp just show me a solution to insert iframe here: https://htmlview.glitch.me/ maybe we can reconsider using iframe for the tutorial part now

@VarLad
Copy link
Contributor

VarLad commented May 18, 2021

Try implementing it with the existing tutorials to see how it goes?

@VarLad
Copy link
Contributor

VarLad commented Jun 15, 2021

If anyone lands on this issue, kindly note that I've undertook this Hack

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs need to do with documentation unitaryhack
Projects
None yet
Development

No branches or pull requests

2 participants