question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Improve `/changelog` page performance

See original GitHub issue

Subject

Changelog

Description

There’s a warning from Next.js about the changelog page being too large in size.

Warning: data for page “/changelog” is 250 kB, this amount of data can reduce performance.

I’m thinking we can use progressive disclosure to improve the page’s performance. Here are some ideas:

  • Show the changelog for only the current version, and hide the rest
  • Include the Table of Content on the right side that shows the previous versions so the users can navigate to the version they’re interested in.
  • Consider using a dynamic route /changelog/<version> to determine which changelog to show

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Reactions:1
  • Comments:11 (9 by maintainers)

github_iconTop GitHub Comments

3reactions
segunadebayocommented, May 22, 2022

A mental model I have to resolve this:

  • In the core repo, break each changelog versions into their own files so we have a structure like .changelog/v2.0.0.mdx, .changelog/v2.0.2.mdx, etc.
  • Update the GitHub actions in the core repo, such that we also write to the .changelog/v{{version}}.mdxThis makes it easier to consume in the docs repo.
  • In the changelog page, show the changelog for the most recent version.
  • add a version selector for those who want to go back in time. As they pick the version we can navigate to /changelog/v{{version}} in Next.js which will display the changelog for the selected version.

This will help us achieve progressive disclosure and reduce the page size.

3reactions
segunadebayocommented, Mar 8, 2022

Ideas for the UI and execution:

https://releases.figma.com/ (this one solves the problem with pagination) https://www.sketch.com/updates/ (same with this) https://www.raycast.com/changelog https://linear.app/changelog

Read more comments on GitHub >

github_iconTop Results From Across the Web

More time, tools, and details on the page experience update
To help publishers and site owners improve their page experience and prepare, today we're announcing a few key updates: Gradual rollout starting in...
Read more >
How to Keep a Changelog: 5 Do's and Don'ts - AnnounceKit
1. Don't include everything you do. Writing about detailed technical issues is not that interesting unless it results in some performance gains ...
Read more >
How to evaluate and improve page speed - Moz
To improve your server response time, look for performance bottlenecks like slow database queries, slow routing, or a lack of adequate memory and...
Read more >
9 Quick Ways to Improve Page Loading Speed - HubSpot Blog
Before making any changes to your site, you'll need to gauge your web pages' performance. There are various tools you can use to...
Read more >
Search results for performance |> Changelog
Measure it so you can improve it, but how? …performance metrics are surprisingly challenging to get right. On the one hand, it is...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found