docs: add quick-start guide for engineers#92
Open
faisalnugroho wants to merge 1 commit into
Open
Conversation
Collaborator
🟡 Heimdall Review Status
|
Author
|
Hi! Following up on this docs PR. This PR adds a quick-start guide for engineers covering logo file formats, sizing rules, color specs, and HTML/CSS code examples. Fills the gap between the existing brand guidelines and practical developer usage. All CI checks pass (StepSecurity ✅). Would love to get your review when you have a moment. Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a comprehensive quick-start guide section to the README that helps engineers quickly find and use the right brand assets.
Fixes #75, #77, #78, #80, #82
What's included
Format Selection Guide — When to use SVG vs PNG vs EPS based on context (web UI, email, print, social media).
Logo Variant Selection — Clear table showing which logo variant to use for light, dark, colorful, and blue-themed backgrounds.
Sizing Guidelines — Minimum and recommended sizes for common contexts (favicon, app icon, nav bar, hero, social media).
Social Media Usage — Recommendations for profile pictures, post images, and story overlays.
File Naming Convention — Explanation of the
Base_[variant]_[color].[format]pattern used across all assets.