-
Notifications
You must be signed in to change notification settings - Fork 153
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(use-cases): add use cases entry in the doc website and start add…
…ing content (#1570)
- Loading branch information
Showing
24 changed files
with
938 additions
and
5 deletions.
There are no files selected for viewing
2 changes: 1 addition & 1 deletion
2
website/versioned_docs/version-v2.0_alpha/contributing/_category_.json
This file contains 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
2 changes: 1 addition & 1 deletion
2
website/versioned_docs/version-v2.0_alpha/processes/_category_.json
This file contains 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
2 changes: 1 addition & 1 deletion
2
website/versioned_docs/version-v2.0_alpha/project-ideas/_category_.json
This file contains 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
2 changes: 1 addition & 1 deletion
2
website/versioned_docs/version-v2.0_alpha/security/_category_.json
This file contains 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
2 changes: 1 addition & 1 deletion
2
website/versioned_docs/version-v2.0_alpha/testing/_category_.json
This file contains 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
8 changes: 8 additions & 0 deletions
8
website/versioned_docs/version-v2.0_alpha/use-cases/_category_.json
This file contains 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,8 @@ | ||
{ | ||
"label": "Use Cases", | ||
"position": 6, | ||
"link": { | ||
"type": "generated-index", | ||
"description": "An overview of MACI's main use cases. MACI can be used for a variety of application, especially where stakes are high, such as in public goods funding, governance and local elections." | ||
} | ||
} |
8 changes: 8 additions & 0 deletions
8
website/versioned_docs/version-v2.0_alpha/use-cases/governance/_category_.json
This file contains 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,8 @@ | ||
{ | ||
"label": "Governance", | ||
"position": 1, | ||
"link": { | ||
"type": "generated-index", | ||
"description": "An overview of MACI's use cases in governance applications." | ||
} | ||
} |
8 changes: 8 additions & 0 deletions
8
website/versioned_docs/version-v2.0_alpha/use-cases/governance/governance.md
This file contains 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,8 @@ | ||
--- | ||
title: MACI Governance applications | ||
description: Overview of MACI governance applications. | ||
sidebar_label: Introduction | ||
sidebar_position: 1 | ||
--- | ||
|
||
MACI is a privacy-preserving, on-chain voting protocol. It is designed to be used in a variety of applications where stakes are high, and we believe that governance is one of them. At this time, no governance applications have been built on top of MACI, but we are excited to see what the community will build, and kick-start experiments in the following months. Stay tuned. |
8 changes: 8 additions & 0 deletions
8
website/versioned_docs/version-v2.0_alpha/use-cases/local-elections/_category_.json
This file contains 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,8 @@ | ||
{ | ||
"label": "Local Elections", | ||
"position": 1, | ||
"link": { | ||
"type": "generated-index", | ||
"description": "An overview of MACI's use cases for local elections" | ||
} | ||
} |
8 changes: 8 additions & 0 deletions
8
.../versioned_docs/version-v2.0_alpha/use-cases/local-elections/local-elections.md
This file contains 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,8 @@ | ||
--- | ||
title: MACI Local elections | ||
description: Overview of MACI's usage in local elections. | ||
sidebar_label: Introduction | ||
sidebar_position: 1 | ||
--- | ||
|
||
MACI is a privacy-preserving, on-chain voting protocol. We believe MACI could eventually be used in local elections, where privacy is paramount. At this time, no local elections have been conducted using MACI, but we are excited to continue working on making this a reality, together with our community and their contribution. Stay tuned. |
8 changes: 8 additions & 0 deletions
8
website/versioned_docs/version-v2.0_alpha/use-cases/public-goods-funding/_category_.json
This file contains 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,8 @@ | ||
{ | ||
"label": "Public Goods Funding", | ||
"position": 1, | ||
"link": { | ||
"type": "generated-index", | ||
"description": "An overview of MACI's use cases in public goods funding." | ||
} | ||
} |
88 changes: 88 additions & 0 deletions
88
...ersioned_docs/version-v2.0_alpha/use-cases/public-goods-funding/public-goods.md
This file contains 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,88 @@ | ||
--- | ||
title: Public Goods Funding | ||
description: Overview of public goods funding. | ||
sidebar_label: Introduction | ||
sidebar_position: 1 | ||
--- | ||
|
||
# A toolbox for busy community leaders. | ||
|
||
We’re building technical infrastructure, operational expertise, and a support network to bring Public Goods Funding (PGF) and on-chain privacy technology to communities. | ||
|
||
Our mission is to empower community organisers to run PGF rounds by providing tools, resources, and grants needed to successfully grow adoption of this community-funding technology. | ||
|
||
## What is Public Goods Funding? | ||
|
||
Think crowdfunding and grant-giving where the community weighs the contribution of each project and decides how much of financial funding said project should receive! | ||
|
||
There are different flavors of funding mechanisms, you can find more information about each of them below: | ||
|
||
- [QF: How is this done? 🧐 Learn more here!](/use-cases/public-goods-funding/quadratic-funding/what-is-quadratic-funding.md) | ||
- [RPGF: How is this done? 🧐 Learn more here!](/use-cases/public-goods-funding/retroactive-public-goods-funding/what-is-retroactive-public-goods-funding.md) | ||
|
||
## About us | ||
|
||
We’re a team supported from the Ethereum Foundation, building on-chain, privacy technology that leverages Zero-Knowledge Proofs (ZKP) to empower communities. | ||
|
||
We’re creating infrastructure that enables community leaders to run RPGF rounds in a decentralised manner, independent of us. We aim to empower independent organisers from various communities to run Retroactive Public Goods Funding and Quadratic Funding rounds independently. | ||
|
||
Think of the MACI team as consultants. We offer communities technical training & operational guidance, and the communities then deploy and execute these rounds. | ||
|
||
**We support community operators via:** | ||
|
||
- **Financial grants** | ||
- **Technical guidance** to deploy infrastructure | ||
- **Operational help** on how to structure & manage round logistics | ||
- **Marketing & comms** strategy to ensure your community has adequate content & education | ||
- **Impact analysis** to help you set goals & measure success | ||
|
||
The ultimate goal is for organisers to be able to run rounds independent of us. Here are a few areas we do **not** provide support: | ||
|
||
- Smart contract or website deployment (though we provide guidance on how) | ||
- Direct technical or operational support for voters | ||
- Legal guidance on running rounds | ||
|
||
## How it works | ||
|
||
This site aims to provide a high-level overview of our process, as well as resources on how to run a round. It is not intended to be a rigid solution. | ||
|
||
We offer you technical training and operational guidance but ultimately, you would lead and run your own round! | ||
|
||
- [Get started on Quadratic Funding](/use-cases/public-goods-funding/quadratic-funding/how-it-works.md) | ||
- [Get stsarted on Retroactive Public Goods Funding](/use-cases/public-goods-funding/retroactive-public-goods-funding/how-it-works.md) | ||
|
||
## Case studies | ||
|
||
Our team has already collaborated with multiple community organisers around the globe to empower them to run funding rounds. | ||
|
||
[View case studies of previous Quadratic Funding rounds](/use-cases/public-goods-funding/quadratic-funding/case-studies.md) | ||
[View case studies of previous Retroactive Public Goods Funding rounds](/use-cases/public-goods-funding/retroactive-public-goods-funding/case-studies.md) | ||
|
||
<aside> | ||
🚀 Ready to run a round within your community? | ||
|
||
[Apply now for a QF round!](/use-cases/public-goods-funding/quadratic-funding/apply.md) | ||
[Apply now for a RPGF round!](https://discord.gg/sF5CT5rzrR) | ||
|
||
</aside> | ||
|
||
<aside> | ||
📌 Note: the resources presented here are intended to reflect the latest information and activities happening with the Ethereum Foundation’s MACI team. The information on this site will continue to evolve and expand as our programme matures and becomes more robust! | ||
|
||
**Last updated: 2024-06-14** | ||
|
||
</aside> | ||
|
||
## Explore: | ||
|
||
- How it works | ||
- [How QF works](/use-cases/public-goods-funding/quadratic-funding/how-it-works.md) | ||
- [How RPGF works](/use-cases/public-goods-funding/retroactive-public-goods-funding/how-it-works.md) | ||
- Case studies | ||
- [Case studies of previous QF rounds](/use-cases/public-goods-funding/quadratic-funding/case-studies.md) | ||
- [Case studies of previous RPGF rounds](/use-cases/public-goods-funding/retroactive-public-goods-funding/case-studies.md) | ||
- [What is Quadratic Funding (QF)](/use-cases/public-goods-funding/quadratic-funding/what-is-quadratic-funding.md) | ||
- [What is Retroactive Public Goods Funding (RPGF)](/use-cases/public-goods-funding/retroactive-public-goods-funding/what-is-retroactive-public-goods-funding.md) | ||
- Apply | ||
- [Apply for a QF round](/use-cases/public-goods-funding/quadratic-funding/apply.md) | ||
- [Apply for a RPGF round](https://discord.gg/sF5CT5rzrR) |
8 changes: 8 additions & 0 deletions
8
..._docs/version-v2.0_alpha/use-cases/public-goods-funding/quadratic-funding/_category_.json
This file contains 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,8 @@ | ||
{ | ||
"label": "Quadratic Funding", | ||
"position": 1, | ||
"link": { | ||
"type": "generated-index", | ||
"description": "An overview of Quadratic Funding and how MACI fits in." | ||
} | ||
} |
62 changes: 62 additions & 0 deletions
62
...cs/version-v2.0_alpha/use-cases/public-goods-funding/quadratic-funding/apply.md
This file contains 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,62 @@ | ||
--- | ||
title: Apply to run a public goods funding with us. | ||
description: Overview of public goods funding. | ||
sidebar_label: Apply to run a public goods funding with us. | ||
sidebar_position: 4 | ||
--- | ||
|
||
Ready to run quadratic funding in your community? | ||
|
||
Apply here for matching funds and mentorship! | ||
|
||
<aside> | ||
💡 Before applying to work with us, please ensure you [understand how our process works](how-it-works.md). | ||
|
||
</aside> | ||
|
||
## Time commitment | ||
|
||
Requirements here vary depending on the structure of the round & team size, but communities should expect to allocate the following amount of hours to implement a QF round. | ||
|
||
- **Technical work** | ||
IE. Configuring wallets, deploying contracts & deploying the website | ||
We’d recommend allocating approximately 200 - 250 hours of developer time to prepare for a round. For a dev team with no prior experience with Ethereum development, we’d recommend 300 hours. | ||
- **Operational work** | ||
Marketing, communications, curating & reviewing project applications & community support. This work takes about 300 hours. | ||
|
||
## Eligibility | ||
|
||
In order to receive a grant from the Ethereum Foundation, you’d need complete a KYC process. Here are the documents needed: | ||
|
||
- For individuals | ||
1. Scanned copy of passport | ||
2. Proof of address from within the last 3 months, such as bank statement, utility bill or telecom subscription | ||
- For organizations | ||
1. Certificate of Incorporation | ||
2. Proof of address from within the last 3 months, such as bank statement, utility bill or telecom subscription | ||
3. Shareholders' and Directors' registers / Members' register (for organization without shareholdings) | ||
4. For each director, officer and individual shareholder (more than 10%), please provide (i) scan copy of passport, and (ii) copy of proof of address | ||
5. If the shareholder is an organization and holds more than 10%, please provide 1 through 4 | ||
|
||
## Get started! | ||
|
||
The application process begins by submitting an overview of your proposal to our team: | ||
|
||
<aside> | ||
🚀 [Submit your proposal](https://quadraticfunding.paperform.co/) | ||
|
||
</aside> | ||
|
||
## What to expect after submitting | ||
|
||
We try to review all proposals within a week and will reach out to follow up with you. | ||
|
||
As part of your application, you will have a series of calls with folks from the Ethereum Foundation to discuss you application and review your proposal. Here, we can brainstorm the QF structure, logistics of the round & help answer any question. | ||
|
||
After we land on a round structure, we’ll establish specifics, such as who will receive the grant from your organisation. It takes 4-7 weeks to process the grant proposal, collect all necessary documents, and disburse the grant. | ||
|
||
Read [how it works](how-it-works.md) for an in-depth overview of our process. | ||
|
||
## Questions? | ||
|
||
Join [our Discord](https://discord.gg/sF5CT5rzrR) and ask to get in touch with QFI in the `🔧-collaborate` channel. |
22 changes: 22 additions & 0 deletions
22
...ion-v2.0_alpha/use-cases/public-goods-funding/quadratic-funding/case-studies.md
This file contains 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,22 @@ | ||
--- | ||
title: Case Studies | ||
description: Overview of what is quadratic funding | ||
sidebar_label: Case Studies | ||
sidebar_position: 3 | ||
--- | ||
|
||
# Case Studies | ||
|
||
View some of our previous Quadratic Funding round collaborations below! | ||
|
||
QF rounds come in different shapes in sizes. The hope is that these projects will provide inspiration for prospective organisers on how they may want to structure their QF round. | ||
|
||
- [ETH Honduras](https://www.notion.so/pse-team/ETH-Honduras-22-d1790da6ea0a45f38fdf023a6d10ef46?pvs=4) | ||
- [ETH Latam](https://www.notion.so/pse-team/ETHLatam-22-6250f0f076984879aa38078d212a61f1?pvs=4) | ||
- [ETH Barcelona](https://www.notion.so/pse-team/ETHBarcelona-22-15a5c2d1464c41429d0865b59a4e3242?pvs=4) | ||
- [ETH Colombia](https://www.notion.so/pse-team/ETHColombia-22-af1faa11a6d24c36b7ec846e1f2bfc5d?pvs=4) | ||
- [ETH Prague](https://www.notion.so/pse-team/ETHPrague-22-948c98e6e2fd4b509d44cfc7445bdff6?pvs=4) | ||
- [ETH Dam](https://www.notion.so/pse-team/ETHDam-23-131c320619db4a75b9478bb39ad1d793?pvs=4) | ||
- [ETH Honduras](https://www.notion.so/pse-team/ETH-Honduras-23-8a73c9ce00bf40e896bf6a1caf946710?pvs=4) | ||
- [ETH Argentina](https://www.notion.so/pse-team/ETH-Argentina-23-4836cbac426e4e4cbc56af7b639aa47b?pvs=4) | ||
- [ETHCon Korea](https://www.notion.so/pse-team/ETHCon-Korea-23-38a7c83ab66b4f5f8694141583da5c0a?pvs=4) |
90 changes: 90 additions & 0 deletions
90
...docs/version-v2.0_alpha/use-cases/public-goods-funding/quadratic-funding/faq.md
This file contains 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,90 @@ | ||
--- | ||
title: Quadratic funding - FAQ | ||
description: Overview of public goods funding works. | ||
sidebar_label: FAQ | ||
sidebar_position: 6 | ||
--- | ||
|
||
Read through [how QF works](how-it-works.md) and something still unclear? | ||
|
||
Find answers to common questions below. | ||
|
||
## Incubator process | ||
|
||
### **How can a team get started?** | ||
|
||
[View the steps to apply and get in touch](apply.md) | ||
|
||
### Do teams have to apply for every round? | ||
|
||
Yes, even repeat rounds by the same organizer. | ||
|
||
## Use of grant funds | ||
|
||
### What is the grant amount available to organisers applying for the first time? | ||
|
||
Varies, but up to $20,000 USD. Typically we provide a single “lump sum” grant for the team, who coordinates how it’s allocated e.g. across operational costs & the matching pool. | ||
|
||
### What is the grant amount available to organisers applying for a second/third time? | ||
|
||
It depending on the size of community & projects that took part in the first round, as well as the impact of the funds on the community. However, the above benchmark of $20,000 can be used and every application’s grant request would be individually reviewed. | ||
|
||
### Can teams propose a different way to split or use the money? | ||
|
||
Yes, it’s ultimately up to the team to propose the structure. We can provide guidance based on what’s worked in other situations, but we try to be flexible & recognise that each round is unique. The direct grant portion should be related to amount of work required. | ||
|
||
### Who is in charge of managing budget? | ||
|
||
Once a grant is allocated, it’s up to the team to manage the delegation of the budget. | ||
|
||
## Funding rounds | ||
|
||
### Is there a limit to the number of projects that can participate in a round? | ||
|
||
Yes, given constraints of the ZK system of smart contracts used to prevent bribery & collusion, we are capped at 125 projects and 8 votes per person. Please take this into account when organising your round! | ||
|
||
### What should our eligibility criteria be for recipient projects? | ||
|
||
Ultimately it’s up to you to propose, but we always push to support projects working on Public Goods. | ||
|
||
Addition criteria for projects to typically become eligible include: | ||
|
||
- Project ownership | ||
- The project must be yours or you must have permission from the project owner | ||
- Free and open source | ||
- Project code must be available to anyone to use under a free and open source license | ||
- KYC | ||
- People or projects must complete some basic KYC/AML requirements | ||
- No scams | ||
- Obviously, your project must not put anyone's funds or information at risk | ||
|
||
### What is the definition of a Public Good? | ||
|
||
We take a broad definition: Public Good means something is open and free for anyone to use. However if people have to buy ICO tokens to enjoy its benefit, it’s not public good. | ||
|
||
**Must public goods be non-profit?** | ||
|
||
For profits can be public goods. For example early stage Uniswap was a public good. After token it feels less like a public good now and/or they have other ways of raising funds. | ||
|
||
### Must the recipient projects benefit the Ethereum community? | ||
|
||
No, we’re open to proposals from teams here. | ||
|
||
For example, communities have included projects that are working on projects that work to reduce the impact of climate change, such as beach clean ups, carbon offsets, helping farmers in rural areas etc. | ||
|
||
### Which chains the funding round be run on? | ||
|
||
We would like for everything to be on an optimistic rollup on Ethereum, as it aligns with our values of decentralisation and helps us reach our goal of being able to do this at a huge scale in a decentralised way. Side chains are acceptable if situation requires it. | ||
|
||
## Case studies | ||
|
||
### What are examples of past QF rounds you’ve helped run? | ||
|
||
[View our case studies](case-studies.md) to get a sense of different ways we’ve collaborated with communities. | ||
|
||
<aside> | ||
🤔 Have a question not answered here? Please let us know! We’re happy to help. | ||
|
||
Join [our Discord](https://discord.gg/sF5CT5rzrR) & ask in the `#🗳️-maci` channel. | ||
|
||
</aside> |
Oops, something went wrong.