Skip to content

Commit 0ad2351

Browse files
authored
Merge branch 'dev' into use-dot-eth
2 parents 7a780b3 + c9577e6 commit 0ad2351

File tree

539 files changed

+17373
-5996
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

539 files changed

+17373
-5996
lines changed

.all-contributorsrc

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10984,7 +10984,8 @@
1098410984
"avatar_url": "https://avatars.githubusercontent.com/u/9151261?v=4",
1098510985
"profile": "https://github.com/aslikaya",
1098610986
"contributions": [
10987-
"doc"
10987+
"doc",
10988+
"maintenance"
1098810989
]
1098910990
},
1099010991
{
@@ -11662,6 +11663,24 @@
1166211663
"contributions": [
1166311664
"content"
1166411665
]
11666+
},
11667+
{
11668+
"login": "WuRuiLei2023",
11669+
"name": "WuRuiLei2023",
11670+
"avatar_url": "https://avatars.githubusercontent.com/u/149141323?v=4",
11671+
"profile": "https://github.com/WuRuiLei2023",
11672+
"contributions": [
11673+
"bug"
11674+
]
11675+
},
11676+
{
11677+
"login": "radeksvarz",
11678+
"name": "Radek",
11679+
"avatar_url": "https://avatars.githubusercontent.com/u/6020891?v=4",
11680+
"profile": "http://www.edukids.cz",
11681+
"contributions": [
11682+
"eventOrganizing"
11683+
]
1166511684
}
1166611685
],
1166711686
"contributorsPerLine": 7,

.github/labeler.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
"review needed :eyes:":
1+
"needs review 👀":
22
- src/**/*
33
- public/*
44

5-
"documentation :book:":
5+
"documentation 📖":
66
- README.md
77

8-
"tooling :wrench:":
8+
"tooling 🔧":
99
- .github/**/*
1010
- src/scripts/*
1111
- src/lib/*
1212
- src/hooks/*
1313

14-
"dependencies :package:":
14+
"dependencies 📦":
1515
- package.json
1616
- yarn.lock
1717

18-
"internal :house:":
18+
"internal 🏠":
1919
- .all-contributorsrc
2020
- i18n.config.json
2121
- next.config.js
@@ -29,14 +29,14 @@
2929
- .prettierrc
3030
- netlify.toml
3131

32-
"translation :earth_africa:":
32+
"translation 🌍":
3333
- src/content/translations/**/*
3434
- src/intl/**/*
3535
- src/lib/utils/translations.ts
3636

37-
"content :fountain_pen:":
37+
"content 🖋️":
3838
- src/pages/*
3939
- public/content/**/*
4040

41-
"event :date:":
41+
"event 📅":
4242
- src/data/community-events.json

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1694,7 +1694,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
16941694
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Crosstons"><img src="https://avatars.githubusercontent.com/u/110349596?v=4?s=100" width="100px;" alt="Shubh"/><br /><sub><b>Shubh</b></sub></a><br /><a href="#content-Crosstons" title="Content">🖋</a></td>
16951695
<td align="center" valign="top" width="14.28%"><a href="https://github.com/duckdegen"><img src="https://avatars.githubusercontent.com/u/98649644?v=4?s=100" width="100px;" alt="duckdegen"/><br /><sub><b>duckdegen</b></sub></a><br /><a href="#content-duckdegen" title="Content">🖋</a></td>
16961696
<td align="center" valign="top" width="14.28%"><a href="https://github.com/sminempepe"><img src="https://avatars.githubusercontent.com/u/76882704?v=4?s=100" width="100px;" alt="sminempepe"/><br /><sub><b>sminempepe</b></sub></a><br /><a href="https://github.com/ethereum/ethereum-org-website/commits?author=sminempepe" title="Documentation">📖</a></td>
1697-
<td align="center" valign="top" width="14.28%"><a href="https://github.com/aslikaya"><img src="https://avatars.githubusercontent.com/u/9151261?v=4?s=100" width="100px;" alt="aslikaya"/><br /><sub><b>aslikaya</b></sub></a><br /><a href="https://github.com/ethereum/ethereum-org-website/commits?author=aslikaya" title="Documentation">📖</a></td>
1697+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/aslikaya"><img src="https://avatars.githubusercontent.com/u/9151261?v=4?s=100" width="100px;" alt="aslikaya"/><br /><sub><b>aslikaya</b></sub></a><br /><a href="https://github.com/ethereum/ethereum-org-website/commits?author=aslikaya" title="Documentation">📖</a> <a href="#maintenance-aslikaya" title="Maintenance">🚧</a></td>
16981698
</tr>
16991699
<tr>
17001700
<td align="center" valign="top" width="14.28%"><a href="http://lucasamberg.dev"><img src="https://avatars.githubusercontent.com/u/102396588?v=4?s=100" width="100px;" alt="Lucas Amberg"/><br /><sub><b>Lucas Amberg</b></sub></a><br /><a href="https://github.com/ethereum/ethereum-org-website/commits?author=lucas-amberg" title="Documentation">📖</a></td>
@@ -1791,6 +1791,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
17911791
<td align="center" valign="top" width="14.28%"><a href="https://github.com/bh2smith"><img src="https://avatars.githubusercontent.com/u/11778116?v=4?s=100" width="100px;" alt="Benjamin Smith"/><br /><sub><b>Benjamin Smith</b></sub></a><br /><a href="https://github.com/ethereum/ethereum-org-website/issues?q=author%3Abh2smith" title="Bug reports">🐛</a></td>
17921792
<td align="center" valign="top" width="14.28%"><a href="http://hector.im"><img src="https://avatars.githubusercontent.com/u/12469549?v=4?s=100" width="100px;" alt="Héctor Chong"/><br /><sub><b>Héctor Chong</b></sub></a><br /><a href="#content-Hector-Chong" title="Content">🖋</a></td>
17931793
<td align="center" valign="top" width="14.28%"><a href="https://github.com/nakmr"><img src="https://avatars.githubusercontent.com/u/145886319?v=4?s=100" width="100px;" alt="nace.kimura"/><br /><sub><b>nace.kimura</b></sub></a><br /><a href="#content-nakmr" title="Content">🖋</a></td>
1794+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/WuRuiLei2023"><img src="https://avatars.githubusercontent.com/u/149141323?v=4?s=100" width="100px;" alt="WuRuiLei2023"/><br /><sub><b>WuRuiLei2023</b></sub></a><br /><a href="https://github.com/ethereum/ethereum-org-website/issues?q=author%3AWuRuiLei2023" title="Bug reports">🐛</a></td>
1795+
<td align="center" valign="top" width="14.28%"><a href="http://www.edukids.cz"><img src="https://avatars.githubusercontent.com/u/6020891?v=4?s=100" width="100px;" alt="Radek"/><br /><sub><b>Radek</b></sub></a><br /><a href="#eventOrganizing-radeksvarz" title="Event Organizing">📋</a></td>
17941796
</tr>
17951797
</tbody>
17961798
</table>

docs/applying-storybook.md

Lines changed: 39 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ It's as easy as running `yarn storybook` to boot up a dedicated localhost to see
1818

1919
## Setting up a component's stories
2020

21-
> 🚨 NOTE: This project uses Storybook v7. The following documentation outlines preferences in setup as it relates to this version. You can refer to the [main docs](https://storybook.js.org/docs/get-started/install) if you need any additional details
21+
> 🚨 NOTE: This project uses Storybook v7, using the Component Story Format v3 and the `satisfies` keyword to define the type of the meta object. The following documentation outlines preferences in setup as it relates to this version. You can refer to the [main docs](https://storybook.js.org/docs/get-started) if you need any additional details
2222
2323
A Storybook "story" is an instance of a component in a certain state or with certain parameters applied to show an alternative version of the component.
2424

@@ -57,9 +57,11 @@ export const Basic: Story = {
5757

5858
**Note**: with the `title` option, we write this based on the groupings set by the Design System. Groupings are declared with forward slashes. (i.e. `Atoms / Form / Input`). See the Storybook docs for details on [Naming conventions](https://storybook.js.org/docs/7.0/react/writing-stories/naming-components-and-hierarchy)
5959

60+
Also, please view the Figma file for the [proposed structure for the Design System](https://www.figma.com/file/Ne3iAassyfAcJ0AlgqioAP/DS-to-storybook-structure?type=design&node-id=42%3A50&mode=design&t=RGkyouvTilzF42y0-1) to provide the correct groupings.
61+
6062
We will maintain this structure for every story file, regardless of simplicity.
6163

62-
Should the component accept props on all or some renders, you can provide an `args` prop for each story and supply the necessary data. And if there is children, use the `render` prop to pass the args and supply children elements.
64+
Should the component accept props on all or some renders, you can provide an `args` prop for each story and supply the necessary data. This can be done in place of the render if only a single instance of the given component is needed with no other components. If the `children` prop is used, it can still be used in the `args` prop.
6365

6466
Let's say for a `Button` component with different style variants...
6567

@@ -77,15 +79,15 @@ export default meta
7779
type Story = StoryObj<typeof meta>;
7880

7981
export const Solid: Story = {
80-
render: (args) => <Button {...args}>A Button</Button>,
8182
args: {
8283
variant: 'solid',
84+
children: 'A Button'
8385
}
8486
}
8587
export const Outline: Story = {
86-
render: (args) => <Button {...args}>A Button</Button>,
8788
args: {
8889
variant: 'outline',
90+
children: 'A Button'
8991
}
9092
}
9193

@@ -94,26 +96,51 @@ export const Outline: Story = {
9496
* they should be shown under one story, so they can be seen side-by-side in the GUI
9597
* for reviewers to easily compare.
9698
* This can also be done for various sizes or other like alterations
99+
*
100+
* 🚨 If prop content is supplied directly to the component and the `args` prop is not used,
101+
* do not use the `StoryObj` type. This is especially important when a story rendering multiple versions
102+
* of the component.
97103
*/
98104

99105
// Assuming `solid` is the default variant in the Chakra theme config
100-
export const Variants = () => (
101-
<VStack>
102-
<Button>A Solid Button</Button>
103-
<Button variant="outline">An Outline Button</Button>
104-
<Button variant="unstyled">An Unstyled Button</Button>
105-
</VStack>
106-
)
106+
export const Variants = {
107+
render: () => (
108+
<VStack>
109+
<Button>A Solid Button</Button>
110+
<Button variant="outline">An Outline Button</Button>
111+
<Button variant="unstyled">An Unstyled Button</Button>
112+
</VStack>
113+
)
114+
}
107115
```
108116

109-
If only one story is provided for a component, the name of the exported object should match the name in the `title` meta option. (If the title is `Atoms / Form / Button` then the object should be named `Button`) This will hoist the display name up to the parent level in the Storybook dashboard's sidebar.
117+
### Story file containing a single story
118+
119+
If only one story is provided for a component, the name of the exported object should match the name in the `title` meta option. (If the title is `Atoms / Form / Button` then the object should be named `Button`) This will hoist the display name up to the parent level in the Storybook dashboard's sidebar. This will also mean you have to rename the import of the component. Call it `ButtonComponent`, say.
120+
121+
```tsx
122+
import ButtonComponent from "."
123+
124+
const meta = {
125+
title: "Atoms / Form / Button",
126+
component: ButtonComponent,
127+
} satisfies Meta<typeof ButtonComponent>
128+
129+
export default meta
130+
131+
export const Button: StoryObj<typeof meta> = {
132+
render: () => <ButtonComponent />,
133+
}
134+
```
110135

111136
As you go and make adjustments to the component itself or it's variant styles, Storybook will hot reload and those changes will appear in the stories that emphasize them.
112137

113138
## Storybook Dashboard
114139

115140
The dashboard where you view each story has a number of different addons available to check the story thoroughly.
116141

142+
![Screenshot of Storybook Dashboard for Ethereum.org](https://github.com/ethereum/ethereum-org-website/assets/65234762/7dea7692-6a6d-4f1c-b7cb-db177bcab44d)
143+
117144
Outlined below are each area going from left to right in the selections.
118145

119146
| Toolbar above the preview | Panel below the preview |

i18n.config.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -423,6 +423,14 @@
423423
"langDir": "ltr",
424424
"dateFormat": "MM/DD/YYYY"
425425
},
426+
{
427+
"code": "te",
428+
"crowdinCode": "te",
429+
"name": "Telugu",
430+
"localName": "తెలుగు",
431+
"langDir": "ltr",
432+
"dateFormat": "MM/DD/YYYY"
433+
},
426434
{
427435
"code": "tk",
428436
"crowdinCode": "tk",

public/content/contributing/design/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@ Our design system makes designing ethereum.org fun and easy. If you are an exper
5151

5252
1. Select an issue to work on from [design system board](https://github.com/ethereum/ethereum-org-website/labels/design%20system) on GitHub or create a new one.
5353
2. Request the selected issue to be assigned to you.
54-
3. Start designing the requested component in figma.
54+
3. Start designing the requested component in Figma.
5555
4. Share it with the design team on GitHub once you need review or guidance.
5656
5. The design team will review.
57-
6. The Design team will incorporate the changes in the main file and publish the file to the community.
57+
6. The design team will incorporate the changes in the main file and publish the file to the community.
5858

5959
### <Emoji text=":six:" size={1} /> &nbsp;Write design-related content on the website {#write-design-articles}
6060

@@ -64,7 +64,7 @@ The Ethereum developer community is strong, but the design community is falling
6464
2. Go to our GitHub repository and [raise an issue](https://github.com/ethereum/ethereum-org-website/issues/new) proposing a topic (do not write the content yet).
6565
3. Wait for the design team to approve.
6666
4. Once approved, write the content.
67-
5. Submit it in the corresponding GH issue.
67+
5. Submit it in the corresponding GitHub issue.
6868

6969
### <Emoji text=":seven:" size={1} /> &nbsp;Draw new illustrations {#prepare-illustrations}
7070

0 commit comments

Comments
 (0)