Discussions

Ask a Question
Back to All

Changelog Short/Long Format Toggle

My apologies if this has been addressed already, but here's my question.

Would it be possible to have a toggle for the changelog to allow for short or long format?

Currently we can only use the short format. For each changelog post, the list view of posts cuts off the post at the first line break. It isn't clear to a user on the list view that there is more in the post. So they would either not read the rest of the post, or they'd have to click into each post individually.

What I would like (if it doesn't exist already) is to toggle to a long format where the list view shows the entirety of all the posts. That not only makes it more of a story to tell for a user, but also saves them from missing out on information or making more clicks.

In the meantime, my coping mechanisms are:

  • Include a "click through for more" style phrase in the initial paragraph like y'all do in your changelog, or
  • Think about embedding the changelog via API somewhere else, which detracts from using the Readme hosting as our primary interface for docs.

Thanks for your consideration and time!