Skip to content

Preview of documentation #5

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

Closed
wants to merge 3 commits into from
Closed

Preview of documentation #5

wants to merge 3 commits into from

Conversation

devmotion
Copy link
Member

No description provided.

@devmotion
Copy link
Member Author

Ah this needs more changes, the custom DeployConfig overwrites the pull_request event and so Documenter does not create a preview build but instead rebuilds the actual docs since it assumes we pushed to master.

It seems one should also not build both stable and dev in a PR. In general, maybe there should be separate triggers for the stable builds only if there is a new release of Turing - it seems a bit strange to rebuild it every time the action is executed.

@devmotion
Copy link
Member Author

Maybe one should first separate the repo more clearly from Turing, as discussed in TuringLang/Turing.jl#1474.

@cpfiffer
Copy link
Member

Ah this needs more changes, the custom DeployConfig overwrites the pull_request event and so Documenter does not create a preview build but instead rebuilds the actual docs since it assumes we pushed to master.

We should probably just check an environment variable here -- the deploy config I added was to allow this to function more like a cron job, but maybe there's a better way to do it.

It seems one should also not build both stable and dev in a PR. In general, maybe there should be separate triggers for the stable builds only if there is a new release of Turing - it seems a bit strange to rebuild it every time the action is executed.

This was a quick hack to get it to remain current. I wasn't able to find a way to have GitHub report pulls/releases in other repos to this one, and this is a nice and easy stateless solution that doesn't require talking to the main Turing.jl repo or performing any record keeping.

@cpfiffer
Copy link
Member

Maybe one should first separate the repo more clearly from Turing, as discussed in TuringLang/Turing.jl#1474.

I'm also not sure what you mean here -- everything that's in this repo is basically just website skeleton. The whole point of make.jl is to go grab any of Turing docs and build them in the website format. It's very separate from Turing.

@devmotion
Copy link
Member Author

I'm also not sure what you mean here -- everything that's in this repo is basically just website skeleton. The whole point of make.jl is to go grab any of Turing docs and build them in the website format. It's very separate from Turing.

I got confused by the setup and only realized this later. Just ignore this comment 🙂

@devmotion devmotion closed this Jan 26, 2021
@devmotion
Copy link
Member Author

This is not useful, as mentioned above it just rebuilds the stable and dev version of the docs. However, the main motivation would be to build it in a separate folder for each PR.

@devmotion devmotion deleted the dw/preview branch May 3, 2022 19:50
shravanngoswamii pushed a commit that referenced this pull request Apr 14, 2025
* paste in svg

* responsive svg header
shravanngoswamii pushed a commit that referenced this pull request Apr 21, 2025
* paste in svg

* responsive svg header
shravanngoswamii added a commit that referenced this pull request Aug 7, 2025
* first part of new landing page (#1)

* very basic redesign

* make buttons interactive

* Add code examples (#2)

* add dangling code example

* add code example section

* Add news (#3)

* quickfix alignment

* add news and clean up scss

* better alignment

* add resources / "learn more" section

* Improved colours (#4)

* improve colors

* better link hover color

* better navbar text contrast

* Add SVG header (#5)

* paste in svg

* responsive svg header

* fix "learn more" hover text-deco

* style team page for dark mode
using the same background colour for the team "cards" as for the non-hoverable cards on the landing page

* more relevant links at top of page
- added links to discourse and slack to the buttons at the top of the page
- moved link to libraries page to "Learn more" section

* mirror gaussians and title

* add css for code in dark mode

* shorten footer for better fit on mobile

* underline links in footer

* responsive header size

* content placeholders on landing page

* Apply suggestions from code review

Co-authored-by: Penelope Yong <[email protected]>

* fix "logo" display by removing h1

* _quarto.yml: comments rewritten

* Turned HTML to Quarto Markdown and added _includes to keep the main page clean

* moved news to _included & added News section sliding animation

* Improve news animation

* removed new styles from this PR but added similar new theme in old format

* Removed new styles of Simon, Updated tons of CSS to match new theme
We will create new PR for Simon's new style

* fixed search results color in dark mode

* Added citations and commented placeholder text

* fix new height & copy button css in dark mode

* Updated News section to have fixed height & updated landing page codes

* added arrows for moving forward and backward in news

* Experiment another approach on news carousel

* speeding news carousel

* don't highlight tutorials button

* update placeholder text

* move tutorial button

* fix unclosed div

* fix buttons properly

* polish text

* delete whatever i wrote

* fix unclosed div etc

* refresh news

* using quarto listing for news carousel

* Updated news carousel

* Mouse scroll in news works fine now

* Updated lot of things, yet to remove news section

* fix urls

* Removed news section, added brands, improvded citations and other parts

* added brands id

* fix team theme in dark mode

* trying custom page-layout

* added side-space

* fix libraries page in dark mode

* few more fixes

* brands text update

* Add Alan Turing Institute Logo

* fix ATI url

* Add maX width as suggested by @simonsteiger

* Add News and Tutorials on Landing Page

* remove logo animation, add news and tuturials, add core packages, improve overall responsiveness

* Updated logo and Added New Logo in Header

* add on hover border on all boxes

* fix colors in dark mode

* Add custom footer, improve citations, fix responsiveness, update theme a bit

* rewrite raw html in quarto markdown, update footer text, core package descriptions and few urls

* update citation icons and footer text

* Add on hover tooltip for citation icons

* improve citations icon

* Update header text

* commit suggestions

* apply suggestions

* Minor Styling Fixes

* save Cambridge University logo in assets

* update .gitignore

* dark mode news improvs

* update my photo in team page

* latest newsletter on landing page

* fix search bar bg color in dark mode

* drop css for scss + few style changes

* add hover color for navbar items

* minor design tweaks and fixes for news and libraries page + overall improvements

* Add $body-bg for just in case we use it

* Add code-block in What is Turing.jl? Section

* experiment merging what is turing and header buttons

* Add codeblock title

* Update index.qmd

Co-authored-by: Penelope Yong <[email protected]>

* Update index.qmd

Co-authored-by: Penelope Yong <[email protected]>

* Update _quarto.yml

Co-authored-by: Penelope Yong <[email protected]>

* add tooltip css for dark mode

* Add all social icons in navbar

* add image for SEO

* Enable Open Graph and Twitter Cards

* Update _quarto.yml

* add png, jpg logo and test open graph image

* test open graph image

* open graph test

* open graph test

* Open Graph ready!

* CLEANUP

* Remove hover effect from codeblock

* Remove emojis from Start Your Journey Section

---------

Co-authored-by: Simon Steiger <[email protected]>
Co-authored-by: simonsteiger <[email protected]>
Co-authored-by: Penelope Yong <[email protected]>
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.

3 participants