You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/contributing/adding-articles/index.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,13 @@ lang: en
4
4
sidebar: true
5
5
---
6
6
7
-
# Adding articles
7
+
# Adding articles {#contributing-to-ethereumorg-}
8
8
9
9
We can't hope to cover everything Ethereum so we try to showcase some of the brilliant articles that the community creates. These often provide more in-depth information on topics that users may be interested in.
10
10
11
11
If there's an article that you feel should be added to a page, feel free to suggest it somewhere appropriate.
12
12
13
-
## How we decide
13
+
## How we decide {#ways-to-contribute}
14
14
15
15
Learning resources will be assessed by the following criteria:
16
16
@@ -22,7 +22,7 @@ Learning resources will be assessed by the following criteria:
22
22
23
23
---
24
24
25
-
## Add your article
25
+
## Add your article {#how-decisions-about-the-site-are-made}
26
26
27
27
If you want to add an article to ethereum.org and it meets the criteria, create an issue on GitHub.
Anyone is free to suggest new wallets and dapps to the content on ethereum.org, where it's appropriate to do so. **No, we won't list your dapp on our homepage** 😜
10
10
@@ -31,15 +31,15 @@ Overall **ethereum.org wants to provide a "seamless onboarding experience" for n
31
31
32
32
Here's our decision framework in more detail. Feel free to provide feedback or suggest changes.
33
33
34
-
## The decision framework
34
+
## The decision framework {#ways-to-contribute}
35
35
36
-
### Criteria for inclusion: the must-haves
36
+
### Criteria for inclusion: the must-haves {#criteria-for-inclusion-the-must-haves}
37
37
38
38
-**An audited product** – this reduces the risk to our users and shows us that you take security seriously.
39
39
-**A product****that has been "live" for over 6 months** – this is another indication of security. 6 months is a good timeframe for critical bugs and exploitations to have been found.
40
40
-**Worked on by an active team** – this helps ensure quality and that a user will get support with their queries.
41
41
42
-
### Criteria for ranking: the nice-to-haves
42
+
### Criteria for ranking: the nice-to-haves {#criteria-for-ranking-the-nice-to-haves}
43
43
44
44
Your dapp or wallet may not be listed on ethereum.org as prominently as others because of the following criteria.
45
45
@@ -59,7 +59,7 @@ Your dapp or wallet may not be listed on ethereum.org as prominently as others b
59
59
-**Open source** – your code should be accessible and you should accept PRs from the wider community.
60
60
-**Community** – you have a dedicated community, maybe a Discord, where users can interact with your team to get help or suggest new features.
61
61
62
-
## Criteria in practice
62
+
## Criteria in practice {#how-decisions-about-the-site-are-made}
63
63
64
64
The more of the criteria you fill, the more likely your product will find its way onto ethereum.org.
65
65
@@ -76,11 +76,11 @@ This is a design decision that ethereum.org is responsible for.
76
76
77
77
But rest assured, **there will be links to other websites that rank more dapps/wallets**
78
78
79
-
### Terms of use
79
+
### Terms of use {#terms-of-use}
80
80
81
81
Please also refer to our [terms of use](/terms-of-use/). Information on ethereum.org is provided solely for general information purposes.
82
82
83
-
## Maintenance
83
+
## Maintenance {#contributors}
84
84
85
85
As is the fluid nature of Ethereum, teams and products come and go and innovation happens daily, so we'll undertake routine checks of our content to:
86
86
@@ -93,7 +93,7 @@ _We're also investigating options for voting so the community can indicate their
93
93
94
94
---
95
95
96
-
## Add your product
96
+
## Add your product {#give-feedback}
97
97
98
98
If you want to add a wallet or dapp to ethereum.org and it meets the criteria, create an issue on GitHub.
👋 Hello, and welcome to the **design principles** for ethereum.org. This is part of an ongoing process to evolve and improve ethereum.org.
10
10
11
11
Our principles inform the look and feel of the site and the content that's on it.
12
12
13
13
You should read these before you [contribute to ethereum.org](/contributing/).
14
14
15
-
## What are design principles?
15
+
## What are design principles? {#ways-to-contribute}
16
16
17
17
Don't worry, they're pretty simple! **Design principles** are a set of guidelines we refer to when designing (i.e. creating, maintaining or updating) something.
18
18
19
19
In the context of ethereum.org these design principles are the foundation for what we want the website to represent and project to the world. They're both aspirational **and** functional. It's not just how the website _looks_, but also how it _works_ and even how it makes someone _feel._ Everything, from the colors to the page layouts to how we talk about Ethereum on the website should be informed by these principles.
20
20
21
-
## The principles in practice
21
+
## The principles in practice {#how-decisions-about-the-site-are-made}
22
22
23
23
Let's look at an example. One of the principles is “Credible”, which means that we want visitors to the site to _feel_ and _know_ that the site is trustworthy - just like the wider Ethereum ecosystem. Within that principle, we have 3 functional “sub-principles” that we believe are actionable steps we can take to make the site credible:
24
24
@@ -32,9 +32,9 @@ So when we're making design decisions, or copywriting decisions, we can then ref
32
32
-_“How and where are we showing the ecosystem's size and activity?”_
33
33
-_“Are the new proposed contributions by a community member that I'm reviewing consistent with the current design and writing on the site?”_
34
34
35
-
## The ethereum.org design principles
35
+
## The ethereum.org design principles {#contributors}
36
36
37
-
### 1. Inspirational
37
+
### 1. Inspirational {#1-inspirational}
38
38
39
39
The site should inspire users to dream of how Ethereum can change the world. It should motivate people to explore, play and tinker with the tools and apps of the Ethereum ecosystem.
40
40
@@ -43,7 +43,7 @@ The site should inspire users to dream of how Ethereum can change the world. It
43
43
44
44
Visual Direction • Content
45
45
46
-
### 2. Universal
46
+
### 2. Universal {#2-universal}
47
47
48
48
Ethereum is a global, decentralized project and our audience reflects this. The site should aspire to be accessible to everyone, and sensitive to the world's many cultures.
49
49
@@ -53,7 +53,7 @@ Ethereum is a global, decentralized project and our audience reflects this. The
53
53
54
54
Writing systems • Use of colour • Visual Direction • Content
55
55
56
-
### 3. A Good Story
56
+
### 3. A Good Story {#3-a-good-story}
57
57
58
58
The website should function like a good story. Visitors are on a journey, and the content you contribute is a part of that. Your contributions should fit within a clear narrative: one with a beginning (introduction/entry point), middle (set of learnings and insights), and end (a link(s) to relevant resources, or next steps).
59
59
@@ -62,7 +62,7 @@ The website should function like a good story. Visitors are on a journey, and th
62
62
63
63
User Journeys • Content
64
64
65
-
### 4. Credible
65
+
### 4. Credible {#4-credible}
66
66
67
67
People may be seeking their introduction to the Ethereum ecosystem or they may be skeptics. Acknowledge that responsibility in how you communicate. Ensure that they both leave with greater confidence in the Ethereum ecosystem.
68
68
@@ -72,7 +72,7 @@ People may be seeking their introduction to the Ethereum ecosystem or they may b
The website is the product of many contributors, just like the ecosystem as a whole.
78
78
@@ -86,7 +86,7 @@ Information Architecture • Visual Direction • Code
86
86
87
87
You can see our design principles in action [across our site](/).
88
88
89
-
## Give feedback
89
+
## Give feedback {#give-feedback}
90
90
91
91
**Share your feedback on this document!** One of our proposed principles is “**Collaborative Improvement**” which means that we want the website to be the product of many contributors. So in the spirit of that principle, we want to share these design principles with the Ethereum community.
Copy file name to clipboardExpand all lines: src/content/contributing/index.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,11 @@ lang: en
4
4
sidebar: true
5
5
---
6
6
7
-
# Contributing to ethereum.org 🦄
7
+
# Contributing to ethereum.org 🦄 {#contributing-to-ethereumorg-}
8
8
9
9
ethereum.org is an open-source project. So if you want to help improve [our portal to Ethereum](https://ethereum.org/en/about/), here's how you can help out.
10
10
11
-
## Ways to contribute
11
+
## Ways to contribute {#ways-to-contribute}
12
12
13
13
-[Work on an open issue](https://github.com/ethereum/ethereum-org-website/issues)
14
14
_– Work we've identified that needs doing_
@@ -47,15 +47,15 @@ Before contributing , make sure you're familiar with:
## How decisions about the site are made {#how-decisions-about-the-site-are-made}
51
51
52
52
Decisions about individual PRs, design evolution and major upgrades are made by a team from across the Ethereum ecosystem. This team includes project managers, developers, designers, marketing and communications, and subject matter experts. Community input informs every decision: so please raise questions in issues, submit PRs, or contact the team:
0 commit comments