feat: add /releases page
#1688
feat: add /releases page
#1688
Conversation
✅ Deploy Preview for tauri-docs-starlight ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
I'm really curious if we need this when the same information is on GitHub. What's the objective you're wanting from this? Just a more focused and filtered list of releases to highlight the more important/popular packages? |
|
That and Github releases page UX is awful and doesn't support quick navigation to a certain release (unless you know exactly what release you want) |
amrbashir
force-pushed
the
feat/releases
branch
from
40f6e92 to
765f7ce
Compare
|
Hmm, that's a good point. I also wonder if change logs for the plugins would be nice to have? That could be included on the respective plugin pages. At first I was a bit torn at having the change details inline and running into formatting issues, but it's all markdown so that shouldn't be an issue. On the implementation, I'd prefer polling the GitHub API during build and statically have the changelog on pages instead of dynamically on each page load. That'd reduce overall page load time for the viewer and make it feel snappier (plus makes it so we have less client-side JS to ship). I'd like to play around with the UI a little bit, but what are your thoughts on the above before that? |
Nice one, but inlining is probably not the way to go, just to not pollute documentation, I think all releases just be under
That particular page doesn't need to have the best performance but yeah that would probably be better as it will make implementing
Definitely feel free to do so, I don't very much like the styling I did |
|
Cool. If we do that then I can also just update some of the plugin meta links on the pages to point to a changelog page. Give me a shout if you want me to take a look at anything in the meantime. |
|
Shifted this PR to generate the releases pages on build, should be ready for review. |
|
I don't know why build fails with links validation tbh, @lorenzolewis do you have any idea why this happens? |
|
I believe because the links are formatted like |
Signed-off-by: Lorenzo Lewis <[email protected]>
Can we override this behavior somehow? ideally the link should contain the |
|
Hmm, tbh I don't see anything in Starlight that would affect this, and generating a normal Astro page seems to retain special characters. We're using a slightly old version due to a few dependency incompatibilities so let me check in the morning if I can figure out whats happening. |
|
Actually, it may have to do with Content Collections because they do a tad bit of magic sauce on top of the default route handling. We can try this and see if it works (away from computer right now): https://docs.astro.build/en/guides/content-collections/#defining-custom-slugs |
It didn't work unfortunately, the error is coming from this plugin though https://github.com/HiDeoo/starlight-links-validator |
|
If we can get the sidebar to show on all pages I'd say we can merge this and think of improvements later. Shows here: https://deploy-preview-1688--tauri-docs-starlight.netlify.app/releases/ |
|
@simonhyll to account for this then I changed the design so the list of releases is enclosed in a dropdown like menu, as if it's mobile. Not quite good looking imo, but gtg I'd say |
What kind of changes does this PR include?
Description
Add a release notes page.