-
Notifications
You must be signed in to change notification settings - Fork 130
docs: add design.md and update CONTEXT.md #1023
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
Open
hwaseonchoi
wants to merge
1
commit into
PrestaShop:develop
Choose a base branch
from
hwaseonchoi:docs/add-design-md
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # Hummingbird — Design System | ||
|
|
||
| ## Source of Truth | ||
|
|
||
| The Figma file is the visual reference for all Hummingbird components and pages. | ||
| It is public and open to the community, agencies, and module developers without | ||
| login. | ||
|
|
||
| **Figma:** [HUMMINGBIRD — new](https://www.figma.com/design/ZlLqiOjTVXVlVu49sSsD8P/HUMMINGBIRD--new-?node-id=0-1) | ||
| Access: public, read-only. | ||
|
|
||
| The file is organized as follows: | ||
|
|
||
| - **One Figma page per storefront page** — each contains a `DESKTOP` frame and | ||
| a `MOBILE` frame side by side. | ||
| - **Components** — component library (atoms, molecules, organisms). | ||
| - **Icons** — icon set. | ||
|
|
||
| Storefront pages covered: Home, Product, Category, Cart, Checkout, Sign in, | ||
| Contact, Stores, My account, 404. | ||
|
|
||
| ### Desktop vs. Mobile coverage | ||
|
|
||
| | Version | Status | Notes | | ||
| |---------|--------|-------| | ||
| | Desktop ✅ | Complete | All storefront pages designed. Reference for implementation. | | ||
| | Mobile 🏗️ | In progress | Frames exist for all pages but coverage is incomplete. Do not treat mobile frames as final — verify before implementing. | | ||
|
|
||
| The Figma is the reference for new component design and for verifying visual | ||
| regressions on desktop. For mobile, align with the desktop Figma intent and flag | ||
| gaps rather than improvising. | ||
|
|
||
| ## Design System | ||
|
|
||
| **Framework:** Bootstrap 5.3.3 | ||
| **Package:** `bootstrap` (npm) | ||
| **Override layer:** `src/scss/bootstrap/overrides/` — Bootstrap variable overrides (loaded before Bootstrap core) | ||
|
|
||
| Hummingbird does not ship a standalone design system. Bootstrap 5.3.3 is the | ||
| design system. The theme's role is to customize it as little as possible while | ||
| meeting PrestaShop storefront requirements. | ||
|
|
||
| **Maturity:** Production — this is the shipped default theme for PrestaShop 9.1+. | ||
| Visual regressions and accessibility regressions are treated as bugs. | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These two lines should be removed.