TuringLang / docs

Documentation and tutorials for the Turing language
https://turinglang.org/docs/
MIT License
231 stars 99 forks source link

fixed preview workflow and added current version in navbar! #488

Closed shravanngoswamii closed 4 months ago

shravanngoswamii commented 4 months ago
  1. Now, previews will not get deleted until PR is either merged or closed!
  2. Nav bar have current version along with a link to changelog and versions file! Screenshot 2024-07-02 180304

closes #473

github-actions[bot] commented 4 months ago

Preview the changes: https://turinglang.org/docs/pr-previews/488, Please avoid using the search feature and navigation bar in PR previews!

yebai commented 4 months ago

Thanks, @shravanngoswamii -- it looks good; can you remove the relevant links in the left navigation bar now that they are in the top menu?

shravanngoswamii commented 4 months ago

can you remove the relevant links in the left navigation bar now that they are in the top menu?

That's nice but if we do not keep them in sidebar then sidebar will not be there when someone visits changelog or versions file, Is that fine?

yebai commented 4 months ago

That's nice but if we do not keep them in sidebar then sidebar will not be there when someone visits changelog or versions file, Is that fine?

See https://github.com/quarto-dev/quarto-cli/discussions/3951#discussioncomment-4698718

shravanngoswamii commented 4 months ago

@yebai It's done!

Now, we just have to mention minor version in _quarto.yml like v0.32, v0.33 and it will automatically detect the latest bug-fix of that version and publishes site to it and if the version is latest then it publishes site to latest bug-fix version! If the version in _quarto.yml is old and someone opens a PR, then vcheck.yml will suggest changing to latest in PR! I have changed the suggestion workflow because the previous one is not working properly, it was suggesting the lines that are not even changed!

See https://github.com/shravanngoswamii/docs/pull/83 for our example of our current suggestion workflow!

Edit: only issue is, if we update any old version, then PR should be from some branch of original repo and not a fork!

shravanngoswamii commented 4 months ago

I have opened a PR for library.qmd in our main site's repo — https://github.com/TuringLang/turinglang.github.io/pull/82

yebai commented 4 months ago

Many thanks @shravanngoswamii!

shravanngoswamii commented 4 months ago

It's my pleasure, I have learned a lot of things while making Turing's site, so thanks a lot to you for this opportunity!!