Introduction

What WhatsNew is and how its pieces fit together.

WhatsNew tells your users what changed in your product, where they already are. You write an update once and it shows up in three places:

  • The in-app widget. A "What's new" panel inside your app, opened from a floating button, a bell in your header or any element you choose, with an unread badge.
  • Your public changelog. A hosted page at yourproduct.whatsnew.xrisstech.com, with one page per update and an RSS feed.
  • Your users' readers. The RSS feed works in any feed reader and in tools like Slack's RSS app.

How it works

  1. You write an update in the dashboard: a title, a Markdown body, images and labels such as New, Improved or Fixed. Publish it now or schedule it.
  2. Publishing updates your public changelog and the widget's feed. Readers see it within about half a minute.
  3. The widget shows a badge with the number of updates the visitor hasn't seen. Opening the panel marks them as read.

The widget is a single script, under 15 KB, that loads asynchronously and runs in an isolated Shadow DOM: it can't break or restyle your page, and your CSS can't break it. It sets no cookies.

Next steps