Skip to content

Commit 2642b20

Browse files
authored
Update/refresh docs (#11)
* update docs * add governance * add overview of contracts * add donation ENS * change membership to table, separate observers * add reporting template link * define package manager * upgrade docusaurus packages * update browserslist db
1 parent 1c92e85 commit 2642b20

File tree

15 files changed

+3417
-3867
lines changed

15 files changed

+3417
-3867
lines changed

docs/background/architecture.md

Lines changed: 0 additions & 77 deletions
This file was deleted.

docs/background/assets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 5
2+
sidebar_position: 4
33
---
44

55
# Assets

docs/background/categories.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ They are public goods for developers on Ethereum in the truest sense of the word
1010

1111
The Guild consists of four categories of developer tooling projects.
1212

13-
- [Client integration libraries](#client-integration-libraries)
1413
- [Smart contract languages](#smart-contract-languages)
15-
- [Development frameworks](#development-frameworks)
16-
- [Standardisation public goods](#standardisation-public-goods)
14+
- [Client libraries](#client-libraries)
15+
- [Frameworks and developer environments](#development-frameworks)
16+
- [Standardization tooling](#standardisation-tooling)
1717

1818
These are outlined below.
1919

20-
## Client Integration Libraries
20+
## Client Libraries
2121

22-
Client integration libraries provide developers using popular programming languages the ability to interact with the Ethereum blockchain. The types of interactions typically encompass querying the blockchain via Ethereum clients (nodes), the deployment of and transacting with smart contracts, and transacting with the Ether cryptocurrency. 
22+
Client libraries provide developers using popular programming languages the ability to interact with the Ethereum blockchain. The types of interactions typically encompass querying the blockchain via Ethereum clients (nodes), the deployment of and transacting with smart contracts, and transacting with the Ether cryptocurrency. 
2323

2424
Programming languages in scope include those listed in [IEEE’s Spectrum Top Programming Languages Report](https://spectrum.ieee.org/top-programming-languages-2024) JavaScript/Typescript, Python, Java/Android, C#/.NET framework and Rust (Go is the one notable exception from the list, which lacks a dedicated RPC integration library. The [geth codebase](https://geth.ethereum.org/) is typically used for this purpose). 
2525

@@ -33,17 +33,17 @@ The ecosystem primarily includes Solidity and Vyper, but also includes emerging
3333

3434
## Development Frameworks
3535

36-
Development frameworks encompass those specifically targeting developers developing smart contracts and DApps for Ethereum (this is unlike integration libraries which cater primarily for integrating with Ethereum clients using specific programming languages). 
36+
Frameworks and developer environments encompass those specifically targeting developers developing smart contracts and DApps for Ethereum (this is unlike client libraries which cater primarily for integrating with Ethereum clients using specific programming languages). 
3737

3838
They provide functionality for developers to create, test, deploy and interact with smart contracts and DApps on Ethereum. 
3939

40-
These development frameworks typically utilise client integration libraries to provide a simplified developer experience to develop DApps for Ethereum. However, a number of client integration libraries could also be considered development frameworks based on their full feature set.
40+
These development frameworks typically utilise client libraries to provide a simplified developer experience to develop DApps for Ethereum. However, a number of client libraries could also be considered development frameworks based on their full feature set.
4141

42-
## Standardisation Public Goods
42+
## Standardisation Tooling
4343

4444
These are public good services that provide standardised data for other developer tools, as well as app developers on Ethereum.
4545

46-
This category includes smart contract verification [Sourcify](https://sourcify.dev/) and the Ethereum metadata service [ethereum-lists](https://github.com/ethereum-lists).
46+
This category includes smart contract verification [Sourcify](https://sourcify.dev/).
4747

4848
# Future Categories
4949

docs/background/impact.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ Impact metrics are less tangible and could include metrics such as:
3232

3333
- Projects or companies using tool
3434
- Annual developer survey - asking developers about their tooling stack, languages, etc.
35-
- Interview (or at least review) top 100 project teams for their devtools stack (also a great opportunity to encourage their sponsorship)
35+
- Interview (or at least review) top 100 project teams for their dev tools stack (also a great opportunity to encourage their sponsorship)
3636
- Minimal published audits to demonstrate funding is going towards FOSS tool(s)development and maintenance, and not other commercial aspects of the receiving organization
3737
- Projects rewarded by airdrops may be a helpful metric for determining the impact of projects. For instance, the following airdrops have provided some useful information on OSS they have benefited from:
3838
- EigenLayer Stakedrop Season 2 ([announcement](https://blog.eigenfoundation.org/season-2-stakedrop/), [spreadsheet of beneficiaries](https://docs.google.com/spreadsheets/d/164W5f7xGzNnd_WKnzRDqTTvlcaRt2mTOnTL0DlnFmhM/edit?ref=blog.eigenfoundation.org&gid=0#gid=0))
3939
- Avail Unification Drop ([announcement](https://blog.availproject.org/avails-unification-drop/#phase-2), [spreadsheet of beneficiaries](https://docs.google.com/spreadsheets/d/1ju4svzoWbadKZnLiDgQiqgBRVCjqCrSzkpHRtoHEwSs/edit?ref=blog.availproject.org&gid=1131269803#gid=1131269803))
40-
- Optimism's Retro Funding rounds
40+
- Optimism's [Retro Funding rounds](https://atlas.optimism.io/missions)
4141
- Industry reports may be helpful such as [Electric Capital Developer Report](https://www.developerreport.com/developer-report)
4242
- Ethereum Stack Overflow activity — [example](https://ethereum.stackexchange.com/questions/tagged/web3j)
4343
- Partnership with projects such as [https://openq.dev/](https://openq.dev/) that provide deep analysis on open-source projects. 
@@ -55,7 +55,7 @@ Whilst FOSS is developed in the open, heading to project GitHub repos, social ac
5555

5656
The reporting template is not intended to be onerous for teams to fill out but should capture enough information to be useful.
5757

58-
A bi-annual cadence will be used for reporting by members, using the following template (TODO: insert link). Inspiration for this are outlined below.
58+
A bi-annual cadence will be used for reporting by members, using the [reporting template](../member-resources/reporting-template.md). Inspiration for this are outlined below.
5959

6060
- Octant’s [long-term and short term project templates](https://docs.octant.app/reporting-templates.html#project-proposal-template)
6161
- Annual and quarterly reports such as performed by Decentralized Trust Foundation (formerly Hyperledger) 

docs/background/why.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,12 @@ sidebar_position: 1
55

66
# Why a Guild?
77

8-
In short, maintaining open-source, public good developer tooling is difficult, and bringing together a collective of tooling projects across the Ethereum ecosystem offers significant benefits.
8+
Foundational developer tools are at times underfunded, siloed, or disconnected from protocol development. The Dev Tools Guild exists to raise the tide by **improving alignment, increasing visibility, and ensuring long-term sustainability across the ecosystem.**
9+
10+
Our goals:
11+
* **Fund critical infrastructure**. Many of the tools developers rely on are built and maintained by small, focused teams or a single individual. The guild exists to ensure that foundational work is sustainably supported and aligned with Ethereum’s long-term growth.
12+
* **Connect app developers to core protocol discussions**. The guild works to bridge the gap between core protocol development and the application layer, helping app developers stay informed about upcoming protocol changes that may affect them, and surfacing developer sentiment to protocol contributors when it can help guide decision-making.
13+
* **Increase coordination and accountability**. The guild facilitates coordination across tooling teams by enabling visibility into roadmaps, encouraging cross-project knowledge sharing, and providing funders and the community with a clearer signal of where meaningful progress is being made.
914

1015
## Reliable Runway, Reliable Tools
1116

docs/donate.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ sidebar_position: 5
44

55
# Donate
66

7-
|Network|Address|
7+
|Network|Address (ENS) |
88
|---|---|
9-
|Ethereum Mainnet|*Coming soon*|
9+
|Ethereum mainnet|[donate.devtoolsguild.eth](https://etherscan.io/address/donate.devtoolsguild.eth)|

docs/faq.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ sidebar_position: 10
88

99
Protocol Guild (PG) is a collective funding mechanism for Ethereum layer 1 R&D. Whilst PG heavily inspired the Dev Tools Guild (DTG), DTG exists to provide a coordination mechanism and collective funding for widely used developer tooling, enabling developers to easily build applications on Ethereum.
1010

11+
DTG membership consists of both projects and individuals, compared with PG which is only individuals.
12+
1113
### Why am I donating to projects I don’t personally use?
1214

1315
DTG supports a broad and diverse range of developers. By remaining accessible to a wide range of developers using different languages and frameworks it increases the surface area of which Ethereum can attract developers, which is key for continuing to grow the Ethereum developer community.
@@ -33,7 +35,7 @@ We want to avoid having very specific criteria which can be gamed or are subject
3335

3436
### How do new projects gain membership?
3537

36-
Until the pilot phase of the guild (likely to run for 1 year commencing early 2025) completes, it is unlikely that new member projects will be onboarded.
38+
Until the pilot phase of the guild (1 year) completes, it is unlikely that new member projects will be onboarded.
3739

3840
During the pilot phase, one goal is to codify the criteria for membership. Broadly speaking, we want to ensure a pathway exists for projects to join the guild if they have demonstrated significant positive impact to the Ethereum development community over a sustained period, are aligned with the mission and values of the guild, and have a team working full-time on the project.
3941

docs/intro.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,19 @@ sidebar_position: 1
33
---
44
# Introduction
55

6+
Dev Tools Guild unites Ethereum developer tool projects to collectively fund individual members & projects, connect app & protocol developers and boost coordination.
7+
8+
Coordinated by Conor Svensson (Founder) and Andrew B Coathup, the guild is starting with a one-year pilot.
9+
610
This documentation explains the *what, why and how* of the Dev Tools Guild.
711

812
![Dev Tools Guild Banner](/img/dtg-banner.png)
913

10-
> ***Note:** Many of the details here are still a work in progress. The documentation is a living document and will be updated as progress is made.*
14+
> ***Note:** The documentation is a living document and will be updated throughout the pilot.*
1115
1216
## Mission
1317

14-
To accelerate the development of apps in the Ethereum ecosystem via world-class tooling.
18+
Accelerate Ethereum app development through world-class tooling.
1519

1620
## Values
1721

0 commit comments

Comments
 (0)