Skip to content

Add versioned asset manifest to simplify updates and cache invalidation #70

@PavlovaVeronikka

Description

@PavlovaVeronikka

Overview

The Base Brand Kit contains multiple visual assets (logos, icons, wordmarks) that may evolve over time. Currently, consumers downloading or embedding these assets have no clear way to detect updates or manage cache invalidation when assets change.

Problem Description

Teams using the Brand Kit often:

  • cache assets locally or via CDN
  • embed assets directly into websites or apps
  • need to know when a logo or asset has been updated

Without a versioned manifest, updates can be missed or require manual comparison.

Expected Behavior

  • Consumers should be able to easily determine the current version of brand assets.
  • Asset updates should be discoverable without manual inspection.
  • Cache invalidation should be straightforward.

Steps to Reproduce

  1. Download or reference assets from the Brand Kit.
  2. Return later to check for updates.
  3. Observe there is no clear indication of asset versioning or change history.

Example

```text
logo.svg
logo-dark.svg
icon.svg
# No version or manifest indicating last update

Proposed Solution

  • Add a machine-readable, versioned asset manifest file (e.g. brand-manifest.json) to the repository.
  • Include metadata for each asset such as name, version or revision hash, and last updated date.
  • Update the manifest whenever any brand asset is modified or added.
  • Document basic usage of the manifest for cache invalidation and update detection.

Acceptance Criteria

  • A versioned asset manifest exists and is kept up to date.
  • Asset changes are accurately reflected in the manifest.
  • Consumers can programmatically detect asset updates using the manifest.
  • No breaking changes to existing asset file paths or names.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions