Skip to content

Commit d816abc

Browse files
MasterHWMasterHW
authored
Pre allo 2.1 docs clean (#97)
* rm blog, rename to registry * various doc updates * fix file removes * Added docs graphics * pnpm lock changes ---------
1 parent ad8a249 commit d816abc

38 files changed

+2927
-2533
lines changed

‎SUMMARY.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99
## Core Concepts
1010

1111
* [Conceptual Overview](core-concepts/conceptual-overview.md)
12-
* [Project Registry](core-concepts/project-registry/README.md)
13-
* [Getting Started](core-concepts/project-registry/getting-started.md)
14-
* [Integrating with the Project Registry](core-concepts/project-registry/integrating-with-the-project-registry.md)
15-
* [Interface and Spec](core-concepts/project-registry/interface-and-spec.md)
12+
* [Project Registry](core-concepts/registry/README.md)
13+
* [Getting Started](core-concepts/registry/getting-started.md)
14+
* [Integrating with the Project Registry](core-concepts/registry/integrating-with-the-registry.md)
15+
* [Interface and Spec](core-concepts/registry/interface-and-spec.md)
1616
* [Program](core-concepts/program.md)
1717
* [Round](core-concepts/round.md)
1818
* [Voting Strategy](core-concepts/voting-strategy/README.md)
@@ -30,5 +30,5 @@
3030

3131
## Extras
3232

33-
* [Getting Involved](extras/getting-involved.md)
34-
* [Allo Improvement Proposals](extras/allo-improvement-proposals.md)
33+
* [Getting Involved](development/getting-involved)
34+
* [Allo Improvement Proposals](development/allo-improvement-proposals)

‎pages/_meta.json

+5-8
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,16 @@
1616
"title": "Strategies",
1717
"type": "page"
1818
},
19-
"project-registry": {
20-
"title": "Project Registry",
19+
"registry": {
20+
"title": "Registry",
2121
"type": "page"
2222
},
2323
"indexer": {
2424
"title": "Indexer",
2525
"type": "page"
2626
},
27-
"blog": {
28-
"title": "Blog",
29-
"type": "page",
30-
"theme": {
31-
"typesetting": "article"
32-
}
27+
"development": {
28+
"title": "Development",
29+
"type": "page"
3330
}
3431
}

‎pages/allo/_meta.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@
2727
"title": "Working with Pools"
2828
},
2929
"auditing-a-strategy":{
30-
"title": "Auditing a Strategy"
30+
"title": "Auditing a Strategy",
31+
"display": "hidden"
3132
},
3233
"contract": {
3334
"type": "separator",

‎pages/allo/building-on-allo.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ In addition to this document, you should review the
1313
page. Combined, the three documents should give you a good idea of the code
1414
you'll need to write to integrate your application with Allo. If you are also
1515
interacting with the Registry, then also review [Integrating with the Project
16-
Registery](/project-registry/integrating-with-the-project-registry).
16+
Registery](/registry/integrating-with-the-registry).
1717

1818
## How to use this page
1919

@@ -78,7 +78,7 @@ A couple of other technical notes about creating a pool:
7878

7979
1. Both methods assume that `msg.sender` is a member of or the owner of the
8080
`_profileId` provided. The `_profileId` is a unique ID provided by the
81-
[Registry](/project-registry). This means that a pool has to be created by
81+
[Registry](/registry). This means that a pool has to be created by
8282
someone who is a part of a project profile.
8383
2. Pools can be created with a starting balance of 0, and then funded later with
8484
`fundPool` (described below). If you're building an application on Allo, this

‎pages/allo/flow-of-funds.mdx

+1-23
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ implements an `allocate()` and `distribute()` method
1414

1515
<div className="my-10">
1616
<Image
17-
src="/flow-of-funds.png"
17+
src="/Flow of funds - 1.png"
1818
alt="Diagram of how funds flow through Allo"
1919
width={1000}
2020
height={500}
@@ -101,25 +101,3 @@ double spending or over spending.
101101
Some things to note:
102102
- Regardless of your allocation strategy, you'll call `distribute()` on `Allo.sol`
103103
- Allocation strategies are responsible for managing how a pool is distributed, not `Allo.sol`
104-
105-
## Miscellaneous
106-
107-
### Aqueducts
108-
109-
The flow of funds through Allo is currently linear: a pool is created and
110-
funded, then it's allocated and distributed through an allocation strategy. Allo
111-
aims to be a general-purpose protocol for allocating resources onchain and that
112-
includes considering where funds come from to fund a pool and where they get
113-
distributed to. Our solution to that is what we call an Aqueduct.
114-
115-
The Allo team is working on a release of an Aqueduct, which is a bonus "wrapper"
116-
around the Allo protocol for communities, DAOs, and protocols to use to make
117-
funding circular:
118-
119-
- An Aqueduct is set up by a community, DAO, or protocol
120-
- Some portion of fees or revenue generated by the owner are deposited into the Aqueduct
121-
- After enough time has passed and enough funds are raised, a pool can be created in Allo to distribute the funds to projects that drive TVL, GMV, or the equivalent metric
122-
- Funding these projects generates more revenue or fees, which replenish the Aqueduct
123-
124-
The Allo protocol team expects to release some research on Aqueducts in Q4 of
125-
2023.

‎pages/allo/working-with-pools.mdx

+10-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
1-
# Working with Pools
1+
import Image from 'next/image'
2+
3+
<div className="my-10">
4+
<Image
5+
src="/Working with Pools.png"
6+
alt="Working with pools"
7+
width={1000}
8+
height={500}
9+
/>
10+
</div>
211

312
Pools handle the implementation of allocation strategies in Allo. While the
413
details of how a pool of funds will be allocated and distributed are reserved

‎pages/blog.mdx

-10
This file was deleted.

‎pages/blog/_meta.json

-11
This file was deleted.

‎pages/blog/allo-v2-announcement.md

-106
This file was deleted.

‎pages/development/_meta.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"getting-involved": "Getting Involved",
3+
"allo-improvement-proposals": "Allo Improvement Proposals"
4+
}

‎pages/overview/allo-improvement-proposals.mdx ‎pages/development/allo-improvement-proposals.mdx

File renamed without changes.

‎pages/development/getting-involved.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Getting Involved
2+
3+
Thank you for your desire to build with Allo!
4+
5+
Below you will find some ways to help, but please don't feel limited by them. A
6+
great place to discuss among community and fellow developers
7+
is the [Gitcoin Discord](https://discord.gg/gitcoin).
8+
9+
## Join the Community
10+
11+
This server has dedicated `⁠👷🏾|grants-lab-builders` & `⁠🔨|allo-protocol-builders`
12+
channels. Find them by agreeing to the server rules, and from the `👋|start-here`
13+
channel gaining the **DAO Visitor** role. Then from the new `👋🏾|dao-start-here`
14+
channel react with `⚒️` to get access to these dedicated builder spaces.
15+
16+
17+
## Building
18+
19+
A great way to get involved is to create your own [allocation
20+
strategy](/strategies). The pieces of an allocation strategy give you a lot of
21+
room to explore and play around with different mechanisms.
22+
23+
Another way to contribute to the Allo ecosystem is to build new tools (front
24+
ends, apps, products, etc) for communities to allocate capital. Allo Protocol
25+
serves as the base-layer, but we need devs like you to build interesting
26+
products on top of it!
27+
28+
When in doubt, post in the above `⁠🔨|allo-protocol-builders` channel or
29+
reach out to [@henrywritestech](https://x.com/henrywritestech) on Twitter/X.

0 commit comments

Comments
 (0)