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

Improve /release page #1996

Closed
wants to merge 4 commits into from
Closed

Conversation

vasfvitor
Copy link
Contributor

Now it utilizes native Starlight TOC.

This is open for discussion about how it should look and function

Copy link

netlify bot commented Mar 26, 2024

Deploy Preview for tauri-docs-starlight ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit a36d61c
🔍 Latest deploy log https://app.netlify.com/sites/tauri-docs-starlight/deploys/66022ec84e941b0008ae3d52
😎 Deploy Preview https://deploy-preview-1996--tauri-docs-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 99 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@amrbashir
Copy link
Member

amrbashir commented Mar 26, 2024

I prefer to have each release has its own dedicated route so it can have better links for example https://beta.tauri.app/releases/tauri/v2.0.0-beta.13/#enhancements this will lead to the the Enhancements section in v2.0.0-beta.13 release, also having each release in its own route, will make the page smaller in size and load faster for user.

While the TOC looks good, we shouldn't rely on it at all, I'd prefer a custom list implementation (potentially with a filtering input box, e.g. type 2.0.0-beta to get only 2.0.0-beta releases).

@simonhyll
Copy link
Sponsor Contributor

@amrbashir You can still do links like this:
https://deploy-preview-1996--tauri-docs-starlight.netlify.app/releases/tauri/#enhancements
We'd just need to update the links that get generated a bit so they target a specific release

I kinda like that it's not separate pages, it's performant and easy to overview.

We could make a similar implementation for this as we did for the features searching list, then we'd just have to put the input field at the top of the page
https://deploy-preview-1996--tauri-docs-starlight.netlify.app/features/

@amrbashir
Copy link
Member

Even if links are fixed, the generated files will only get bigger as time goes on which means more unnecessary traffic and slower load times for users.

@dreyfus92
Copy link
Member

I think that we could implement pagination to fix that issue @amrbashir

@amrbashir
Copy link
Member

fine I guess, but is it really worth that much effort that just plain pages?

@vasfvitor
Copy link
Contributor Author

vasfvitor commented Mar 26, 2024

I'm thinking about this whole situation and long term I personally think that each release having it own route would be the best, no broken links, no need to worry about pagination, less js (edit: less js considering we need to work around starlight design).

Then of course we could have a page for quick reference with all releases for a pkg, possible with a search.

The way I tried to do in PR (one route to rule them all) was to experiment and see it live, gather more ideas. But after seeing the problems arise: broken anchor, possible need to paginate, and mostly important no canonical links. Who knows what else may arise as those pages will always be changing on each release. All of those can be solved, but at what cost?

Now I'm wondering if having a separated releases.tauri.app would be best. This would avoid having to regenerate all the pages in the docs, and because in the current live implementation (dedicated route) the build time doubled:

Build time: 2m 14s. Total deploy time: 2m 14s https://app.netlify.com/sites/tauri-docs-starlight/deploys/660123329fd8ff00088ab0b9

After /releases PR:
Build time: 4m 44s. Total deploy time: 4m 46s https://app.netlify.com/sites/tauri-docs-starlight/deploys/66016d026d31f20008fb3300

Seeing how this will be a time sink (and doesn't help moving tauri to rc?) I'll leave as draft for a while, if anyone reading this wants to use and work on, go ahead

This is still open for ideas and discussion, unless someone from the team says otherwise ofc.

thanks for the feedback @amrbashir @simonhyll and @dreyfus92

@amrbashir
Copy link
Member

I don't mind having a subdomain releases.tauri.app, in fact I lean more towards it.

@dreyfus92
Copy link
Member

Also as side note, hopefully soon Astro will have content collections caching which will lead to faster builds.

@simonhyll simonhyll modified the milestones: Version 2.0, Version 2.x May 3, 2024
@simonhyll simonhyll added the enhancement Does it add or improve content? label May 23, 2024
@vasfvitor
Copy link
Contributor Author

closing considering @simonhyll did a really good job at improving it recently, there's still some requested changes to do (I remember someone mentioned a summary table of versions or something) but this can go into another PR.

https://v2.tauri.app/release/

@vasfvitor vasfvitor closed this May 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Does it add or improve content?
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants