Skip to content

Commit be20f70

Browse files
author
Zakk
committed
set up remark to format markdown
1 parent 548b56c commit be20f70

23 files changed

+1697
-416
lines changed

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ docs.
1818

1919
Fork and clone this repository first, then run the following:
2020

21-
```sh
21+
```sh
2222
pnpm install
2323
```
2424

‎SUMMARY.md

+24-24
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,33 @@
22

33
## Getting Started
44

5-
* [Introduction](README.md)
6-
* [Contracts](getting-started/contracts.md)
7-
* [Subgraph](getting-started/subgraph.md)
5+
* [Introduction](README.md)
6+
* [Contracts](getting-started/contracts.md)
7+
* [Subgraph](getting-started/subgraph.md)
88

99
## Core Concepts
1010

11-
* [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)
16-
* [Program](core-concepts/program.md)
17-
* [Round](core-concepts/round.md)
18-
* [Voting Strategy](core-concepts/voting-strategy/README.md)
19-
* [Getting Started](core-concepts/voting-strategy/getting-started.md)
20-
* [Interface and Spec](core-concepts/voting-strategy/interface-and-spec.md)
21-
* [Writing a Custom Voting Strategy](core-concepts/voting-strategy/writing-a-custom-voting-strategy.md)
22-
* [Security Considerations](core-concepts/voting-strategy/security-considerations.md)
23-
* [Voting Strategy Template](core-concepts/voting-strategy/voting-strategy-template.md)
24-
* [Payout Strategy](core-concepts/payout-strategy/README.md)
25-
* [Getting Started](core-concepts/payout-strategy/getting-started.md)
26-
* [Interface and Spec](core-concepts/payout-strategy/interface-and-spec.md)
27-
* [Writing a Custom Payout Strategy](core-concepts/payout-strategy/writing-a-custom-payout-strategy.md)
28-
* [Security Considerations](core-concepts/payout-strategy/security-considerations.md)
29-
* [Payout Strategy Template](core-concepts/payout-strategy/payout-strategy-template.md)
11+
* [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)
16+
* [Program](core-concepts/program.md)
17+
* [Round](core-concepts/round.md)
18+
* [Voting Strategy](core-concepts/voting-strategy/README.md)
19+
* [Getting Started](core-concepts/voting-strategy/getting-started.md)
20+
* [Interface and Spec](core-concepts/voting-strategy/interface-and-spec.md)
21+
* [Writing a Custom Voting Strategy](core-concepts/voting-strategy/writing-a-custom-voting-strategy.md)
22+
* [Security Considerations](core-concepts/voting-strategy/security-considerations.md)
23+
* [Voting Strategy Template](core-concepts/voting-strategy/voting-strategy-template.md)
24+
* [Payout Strategy](core-concepts/payout-strategy/README.md)
25+
* [Getting Started](core-concepts/payout-strategy/getting-started.md)
26+
* [Interface and Spec](core-concepts/payout-strategy/interface-and-spec.md)
27+
* [Writing a Custom Payout Strategy](core-concepts/payout-strategy/writing-a-custom-payout-strategy.md)
28+
* [Security Considerations](core-concepts/payout-strategy/security-considerations.md)
29+
* [Payout Strategy Template](core-concepts/payout-strategy/payout-strategy-template.md)
3030

3131
## Extras
3232

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

‎package.json

+25-8
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,33 @@
11
{
22
"name": "Allo v2 Documentation",
3-
"version": "0.0.1",
4-
"description": "Documentation for the second version of Gitcoin's Allo Protocol",
3+
"version": "0.0.1",
4+
"description": "Documentation for the second version of Gitcoin's Allo Protocol",
55
"scripts": {
6-
"dev": "next dev",
7-
"build": "next build",
8-
"start": "next start"
9-
},
6+
"dev": "next dev",
7+
"build": "next build",
8+
"start": "next start",
9+
"format": "remark . --output"
10+
},
1011
"dependencies": {
1112
"next": "^13.4.3",
13+
"nextra-theme-docs": "^2.6.0",
1214
"react": "^18.2.0",
13-
"react-dom": "^18.2.0",
14-
"nextra-theme-docs": "^2.6.0"
15+
"react-dom": "^18.2.0"
16+
},
17+
"devDependencies": {
18+
"remark-cli": "^11.0.0",
19+
"remark-frontmatter": "^4.0.1",
20+
"remark-preset-lint-consistent": "^5.1.2",
21+
"remark-preset-lint-recommended": "^6.1.3",
22+
"remark-lint-maximum-line-length": "^3.1.3"
23+
},
24+
"remarkConfig": {
25+
"settings": {},
26+
"plugins": [
27+
"remark-preset-lint-consistent",
28+
"remark-preset-lint-recommended",
29+
"remark-frontmatter",
30+
"remark-lint-maximum-line-length"
31+
]
1532
}
1633
}

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

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Flow of Funds
22

3-
- How funds flow through Allo:
4-
- aqueduct --> pool --> strategy
5-
- allocation and distribution of funds are determined by the strategy
6-
- Ideal is:
7-
- community (DAO, protocol, etc) sets up an aqueduct for running rounds on Allo
8-
- community runs a round, investing/granting in projects that will drive traffic/volume
9-
- protocol fee goes into the aqueduct, kicking of more rounds
3+
* How funds flow through Allo:
4+
* aqueduct --> pool --> strategy
5+
* allocation and distribution of funds are determined by the strategy
6+
* Ideal is:
7+
* community (DAO, protocol, etc) sets up an aqueduct for running rounds on Allo
8+
* community runs a round, investing/granting in projects that will drive traffic/volume
9+
* protocol fee goes into the aqueduct, kicking of more rounds

‎pages/index.mdx

+4-18
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,17 @@ description: What is the Allo Protocol?
1010

1111
## Introduction
1212

13-
Allo Protocol is a set of smart contracts that enable the democratic allocation
14-
and distribution of capital. The protocol was developed by Gitcoin to power the
15-
Grants Stack, but is useful beyond grants and beyond quadratic funding.
13+
Allo Protocol is a set of smart contracts that enable the democratic allocation and distribution of capital. The protocol was developed by Gitcoin to power the Grants Stack, but is useful beyond grants and beyond quadratic funding.
1614

1715
## Why a Protocol for Capital Allocation?
1816

19-
Crypto has given us an incredible tool set for raising capital (token drops,
20-
NFTs) and keeping it (Safe, Governor Bravo). But very little of the money raised
21-
gets allocated back into the community. Instead, it sits in treasuries while
22-
flame wars wage on in governance forums over peanut-sized funding decisions.
17+
Crypto has given us an incredible tool set for raising capital (token drops, NFTs) and keeping it (Safe, Governor Bravo). But very little of the money raised gets allocated back into the community. Instead, it sits in treasuries while flame wars wage on in governance forums over peanut-sized funding decisions.
2318

2419
Why?
2520

26-
Well every proposal has root-level access to the treasury and the entire
27-
community has to be bought in to every funding decision.
21+
Well every proposal has root-level access to the treasury and the entire community has to be bought in to every funding decision.
2822

29-
Allo gives communities a toolset to experiment with capital
30-
allocation. Pick a mechanism (like QF), eligibility criteria for projects and
31-
voters, and how to distribute the capital (lump sum, milestone-based payments,
32-
etc).
23+
Allo gives communities a toolset to experiment with capital allocation. Pick a mechanism (like QF), eligibility criteria for projects and voters, and how to distribute the capital (lump sum, milestone-based payments, etc).
3324

3425
## Use Cases
3526

@@ -56,11 +47,6 @@ An allocation mechanism
5647
## Features
5748

5849

59-
## Values
60-
61-
- pull values/principles from the whitepaper
62-
- link to form to join private TG community of Allo builders
63-
6450
---
6551

6652
through the power of [Quadratic

0 commit comments

Comments
 (0)