Add a quick-start section for engineers (formats, preferred files, and usage tips)
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 62/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start by locating the repository's existing brand guide or README, then review how assets and their light/dark variants are currently organized. Add a clearly labeled engineer quick-start section covering the requested web, mobile, and documentation use cases; done means engineers can choose formats, variants, sizing, and standard files without changing assets.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- No language data
- Stars
- 1.5k
- Forks
- 534
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from base/brand-kit
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
шеф Open
Difficulty 1/5 Under an hour Newbie friendliness 15/100
-
начало Open
Difficulty 5/5 Over a week Newbie friendliness 10/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Ecosystem: ClawMetry — the Qwen Code reader is now free and open source (follow-up to #9294 / #9338) Opencategory/integration priority/P3 scope/documentation status/ready-for-human type/feature-request
Difficulty 1/5 Under an hour Newbie friendliness 84/100