Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pre allo 2.1 docs clean #97

Merged
merged 5 commits into from
Sep 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
## Core Concepts

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

## Extras

* [Getting Involved](extras/getting-involved.md)
* [Allo Improvement Proposals](extras/allo-improvement-proposals.md)
* [Getting Involved](development/getting-involved)
* [Allo Improvement Proposals](development/allo-improvement-proposals)
13 changes: 5 additions & 8 deletions pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,16 @@
"title": "Strategies",
"type": "page"
},
"project-registry": {
"title": "Project Registry",
"registry": {
"title": "Registry",
"type": "page"
},
"indexer": {
"title": "Indexer",
"type": "page"
},
"blog": {
"title": "Blog",
"type": "page",
"theme": {
"typesetting": "article"
}
"development": {
"title": "Development",
"type": "page"
}
}
3 changes: 2 additions & 1 deletion pages/allo/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@
"title": "Working with Pools"
},
"auditing-a-strategy":{
"title": "Auditing a Strategy"
"title": "Auditing a Strategy",
"display": "hidden"
},
"contract": {
"type": "separator",
Expand Down
4 changes: 2 additions & 2 deletions pages/allo/building-on-allo.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ In addition to this document, you should review the
page. Combined, the three documents should give you a good idea of the code
you'll need to write to integrate your application with Allo. If you are also
interacting with the Registry, then also review [Integrating with the Project
Registery](/project-registry/integrating-with-the-project-registry).
Registery](/registry/integrating-with-the-registry).

## How to use this page

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

1. Both methods assume that `msg.sender` is a member of or the owner of the
`_profileId` provided. The `_profileId` is a unique ID provided by the
[Registry](/project-registry). This means that a pool has to be created by
[Registry](/registry). This means that a pool has to be created by
someone who is a part of a project profile.
2. Pools can be created with a starting balance of 0, and then funded later with
`fundPool` (described below). If you're building an application on Allo, this
Expand Down
24 changes: 1 addition & 23 deletions pages/allo/flow-of-funds.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ implements an `allocate()` and `distribute()` method

<div className="my-10">
<Image
src="/flow-of-funds.png"
src="/Flow of funds - 1.png"
alt="Diagram of how funds flow through Allo"
width={1000}
height={500}
Expand Down Expand Up @@ -101,25 +101,3 @@ double spending or over spending.
Some things to note:
- Regardless of your allocation strategy, you'll call `distribute()` on `Allo.sol`
- Allocation strategies are responsible for managing how a pool is distributed, not `Allo.sol`

## Miscellaneous

### Aqueducts

The flow of funds through Allo is currently linear: a pool is created and
funded, then it's allocated and distributed through an allocation strategy. Allo
aims to be a general-purpose protocol for allocating resources onchain and that
includes considering where funds come from to fund a pool and where they get
distributed to. Our solution to that is what we call an Aqueduct.

The Allo team is working on a release of an Aqueduct, which is a bonus "wrapper"
around the Allo protocol for communities, DAOs, and protocols to use to make
funding circular:

- An Aqueduct is set up by a community, DAO, or protocol
- Some portion of fees or revenue generated by the owner are deposited into the Aqueduct
- 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
- Funding these projects generates more revenue or fees, which replenish the Aqueduct

The Allo protocol team expects to release some research on Aqueducts in Q4 of
2023.
11 changes: 10 additions & 1 deletion pages/allo/working-with-pools.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
# Working with Pools
import Image from 'next/image'

<div className="my-10">
<Image
src="/Working with Pools.png"
alt="Working with pools"
width={1000}
height={500}
/>
</div>

Pools handle the implementation of allocation strategies in Allo. While the
details of how a pool of funds will be allocated and distributed are reserved
Expand Down
10 changes: 0 additions & 10 deletions pages/blog.mdx

This file was deleted.

11 changes: 0 additions & 11 deletions pages/blog/_meta.json

This file was deleted.

106 changes: 0 additions & 106 deletions pages/blog/allo-v2-announcement.md

This file was deleted.

4 changes: 4 additions & 0 deletions pages/development/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"getting-involved": "Getting Involved",
"allo-improvement-proposals": "Allo Improvement Proposals"
}
29 changes: 29 additions & 0 deletions pages/development/getting-involved.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Getting Involved

Thank you for your desire to build with Allo!

Below you will find some ways to help, but please don't feel limited by them. A
great place to discuss among community and fellow developers
is the [Gitcoin Discord](https://discord.gg/gitcoin).

## Join the Community

This server has dedicated `⁠👷🏾|grants-lab-builders` & `⁠🔨|allo-protocol-builders`
channels. Find them by agreeing to the server rules, and from the `👋|start-here`
channel gaining the **DAO Visitor** role. Then from the new `👋🏾|dao-start-here`
channel react with `⚒️` to get access to these dedicated builder spaces.


## Building

A great way to get involved is to create your own [allocation
strategy](/strategies). The pieces of an allocation strategy give you a lot of
room to explore and play around with different mechanisms.

Another way to contribute to the Allo ecosystem is to build new tools (front
ends, apps, products, etc) for communities to allocate capital. Allo Protocol
serves as the base-layer, but we need devs like you to build interesting
products on top of it!

When in doubt, post in the above `⁠🔨|allo-protocol-builders` channel or
reach out to [@henrywritestech](https://x.com/henrywritestech) on Twitter/X.
Loading