Skip to content

Add a quick-start section for engineers (formats, preferred files, and usage tips) #75

Description

@imprint-rowboat

Overview

The Base Brand Kit contains many assets and formats, but it is not immediately clear which files engineers should use in common product workflows. A short quick-start guide would help developers pick the right asset format (SVG/PNG), variant (light/dark), and sizing without guesswork.

Problem Description

Engineers integrating brand assets into web or mobile apps may be unsure:

  • which format is preferred for UI (SVG vs PNG)
  • which file variant to use for dark backgrounds
  • how to handle sizing and aspect ratio correctly
  • where to find the “most standard” logo/icon files quickly

This slows down implementation and can lead to inconsistent usage.

Proposed Solution

Add a concise “Engineer Quick Start” section that recommends default assets and formats for common use cases (web UI, mobile UI, docs), explains when to use SVG vs PNG, and points to the correct light/dark variants.

Acceptance Criteria

The repository includes a clearly labeled quick-start section that engineers can follow to select and use the correct assets. The guidance is concise, easy to maintain, and does not require changing existing asset files.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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