Release note template

[CURRENT_VERSION] Release Notes

Changelog

[CURRENT_VERSION] released DATE, and here are the release notes, and any notable changes are described.

The release includes, but not limited to features, documentation, refactoring and bug fixes. For any questions, please contact us!

The SPECCER [CURRENT_VERSION] release includes new navigational structure for the documentation site, quality of life updates for designers and developers, and with low impact design changes, no redesigns are required.

Overview

SPECCER [CURRENT_VERSION] focuses on new navigational structure for the documentation site, documentation separation, package separation and quality of life updates for designers and developers. We’ve also updated the spacing guidelines, to keep spacing more predictable.

What’s new

• Design:

  • We added new spacing guidelines and removed old spacing tokens

• Develop:

  • We removed the usage of babel. It is no longer required with the removal of IE11 support. YMMV, you can bundle source files your self if you want support for outdated browsers
  • Markup change in the Info Card Component, to be able to let the arrow animation on hover to be part of the content flow
  • We eased up on the external link rules, to make it easier to manage
  • Added CDN for CSS (core), JS (JavaScript libraries) and WC (Web Components) packages

• Documentation site:

  • We did some layout adjustments for the documentation site, for a more clean look
  • Improved the search for the documentation
  • Separated out the CSS/JS/WC documentation in a separate page per component. The first page of a component is the design guidelines page
  • New navigational structure for the documentation site. . This makes it easier to navigate to exactly what you want
  • Improved the Component Status page on documentation site

• Components:

  • Navigational Cards of type text now has a visual icon instead of arrow for download links and external links
  • Adjusted the Consent Banner component, we made it less obtrusive
  • We renamed the util-package to utils for all frameworks. See Utils CSS documentation and Utils JavaScript documentation

• Internal

  • Removed old icon category Social from the Nucleo JSON file, it has been replaced by SoMe
  • Converted and renamed remaining design tokens that used Theo to build them. We are now using Style Dictionary everywhere
  • Upgraded to GatsbyJS v4.0.1

What’s not changing

• All components are as is, except from Info Card and Navigational Card

Release FAQs

What are the benefits of SPECCER [CURRENT_VERSION] for me as a designer?

• Better control over spacing, with the new spacing guidelines

)What are the benefits of SPECCER [CURRENT_VERSION] for me as a developer?

• Quality of life updates such as:
  • JavaScript library packages in separate scope, and is now fully supported
  • Web Component packages in separate scope, and is now fully supported

What are the benefits to my external facing users?

• The Consent Banner is less obtrusive

Do I need to update right away? If not, when will we need to update?

• SPECCER [CURRENT_VERSION] includes functionality that may be a motivator for migration, but developers can migrate to [CURRENT_VERSION] when they have the bandwidth
• Developers that are using [PREVIOUS_VERSION] today can continue to stay on [PREVIOUS_VERSION] and everything that is implemented will continue to work

What will SPECCER support for [PREVIOUS_VERSION]?

• No new functionality will be introduced in [PREVIOUS_VERSION] after the [CURRENT_VERSION] release
• We will continue to address high impact bugs that come up for the [PREVIOUS_VERSION] release after the [CURRENT_VERSION] release
• We will continue to accept any contributions that look to address issues in the [PREVIOUS_VERSION] release if we are unable to get to them in time for your sprint

What is the rule for supporting deprecated features?

• Assets that were deprecated from [POST_PREVIOUS_VERSION] to [PREVIOUS_VERSION] will be removed in [CURRENT_VERSION]
• Assets that are deprecated in [PREVIOUS_VERSION] will remain in [CURRENT_VERSION] and will be removed in [FUTURE_VERSION]. The timeline of [FUTURE_VERSION] has not been set

Will I need to redesign something?

• No, we added new spacing guidelines, and they can be adapted into your designs for your upcoming work

How big is the expected effort to migrate code to [CURRENT_VERSION]?

• If applicable, a guide is provided to help with the migration process
• A lot of the changes made will be name-based
• The separation of JavaScript and Web Components requires the install of new packages