Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SPIKE] Adding an example of metadata to the accordion component #4473

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

CharlotteDowns
Copy link
Contributor

@CharlotteDowns CharlotteDowns commented Feb 5, 2025

What

We've spoken as a team about adding more information on when content is changed in the Design System website. It could also help in situations where we need to draw attention to new content.

Why

It can help users to know if something has changed, particularly if there's something that influences it.

Further opportunities

This addition could be timed with removal of the WCAG 2.2 callouts.

At the moment the 'Status' link in this SPIKE links to the backlog issue thread (which I quite like as a prompt) but it could also link to:

  • research section of the page
  • the github history of the poage
  • archives

We also looked at the node example, where they use:

Stability: 0 - Deprecated. The feature may emit warnings. Backward compatibility is not guaranteed.

Stability: 1 - Experimental. The feature is not subject to semantic versioning rules. Non-backward compatible changes or removal may occur in any future release. Use of the feature is not recommended in production environments.
Experimental features are subdivided into stages:

  • 1.0 - Early development. Experimental features at this stage are unfinished and subject to substantial change.
  • 1.1 - Active development. Experimental features at this stage are nearing minimum viability.
  • 1.2 - Release candidate. Experimental features at this stage are hopefully ready to become stable. No further breaking changes are anticipated but may still occur in response to user feedback. We encourage user testing and feedback so that we can know that this feature is ready to be marked as stable.

Stability: 2 - Stable. Compatibility with the npm ecosystem is a high priority.

Stability: 3 - Legacy. Although this feature is unlikely to be removed and is still covered by semantic versioning guarantees, it is no longer actively maintained, and other alternatives are available.

We could also be influenced from/include our accessibility concern rating in the accessibility strategy and use 'theoretical' vs 'evidenced' terminology.

Copy link

netlify bot commented Feb 5, 2025

You can preview this change here:

Name Link
🔨 Latest commit 599475c
🔍 Latest deploy log https://app.netlify.com/sites/govuk-design-system-preview/deploys/67a37bd236ec8100083f1524
😎 Deploy Preview https://deploy-preview-4473--govuk-design-system-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant