Skip to content
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
16 changes: 8 additions & 8 deletions docs/.vitepress/config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
export default {
title: 'DAO Documentation',
description: 'API3 technical documentation',
description: 'Api3 DAO Documentation',
markdown: {
lineNumbers: true,
toc: ['h2', 'h3', 'h4', 'h5'],
Expand All @@ -19,7 +19,7 @@ export default {
{
rel: 'apple-touch-icon',
sizes: '180x180',
href: '/img/small-logo.png',
href: '/img/android-chrome-192x192.png',
},
],
[
Expand All @@ -28,7 +28,7 @@ export default {
rel: 'icon',
type: 'image/png',
sizes: '32x32',
href: '/img/small-logo.png',
href: '/img/android-chrome-192x192.png',
},
],
[
Expand All @@ -37,7 +37,7 @@ export default {
rel: 'icon',
type: 'image/png',
sizes: '16x16',
href: '/img/small-logo.png',
href: '/img/android-chrome-192x192.png',
},
],
],
Expand Down Expand Up @@ -67,20 +67,20 @@ export default {
},
externalLinkIcon: true,
logo: {
light: '/img/API3-Active.png',
dark: '/img/api3-inactive.png',
light: '/img/api3-logo-light-theme.svg',
dark: '/img/api3-logo-dark-theme.svg',
},
siteTitle: 'DAO Documentation',
socialLinks: [
{ icon: 'github', link: 'https://github.com/api3dao/dao-docs' },
{
icon: 'discord',
link: 'https://discord.com/channels/758003776174030948/765618225144266793',
link: 'https://discord.gg/api3dao',
},
],
footer: {
message: 'Released under the MIT License.',
copyright: 'Copyright © 2019-present API3',
copyright: 'Copyright © 2019-present API3 Foundation',
},
sidebar: {
'/': require('../sidebar.js'),
Expand Down
10 changes: 5 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: API3
title: Api3
pageHeader: Overview
outline: deep
---

<PageHeader/>

# What is the API3 DAO?
# What is the Api3 DAO?

API3 delegates much of its governance to the vote of a Decentralized Autonomous
Organization (DAO). API3 is a collaborative effort to build, manage and monetize
Api3 delegates much of its governance to the vote of a Decentralized Autonomous
Organization (DAO). Api3 is a collaborative effort to build, manage and monetize
data feeds at scale. To achieve delegated governance and distribute grants in a
fully decentralized way, the incentives and processes of the participants are
reconciled through the governance, security, and value capture utilities of the
API3 token and its powers in the API3 DAO.
API3 token and its powers in the Api3 DAO.
4 changes: 2 additions & 2 deletions docs/members/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: API3
title: Api3
pageHeader: Members
outline: deep
---
Expand All @@ -9,7 +9,7 @@ outline: deep
# Using the DAO Dashboard

The [DAO Dashboard](https://dao.api3.org/) is the portal to participate in the
API3 DAO. It is aimed at API3 members and others that want to interact with the
Api3 DAO. It is aimed at Api3 members and others that want to interact with the
DAO or modify/reuse any of its infrastructure. The DAO requires a web3 wallet,
such as [MetaMask](https://metamask.io/download/), to be integrated with your
browser. Be sure your wallet is connected to the Ethereum mainnet.
10 changes: 5 additions & 5 deletions docs/members/proposals.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: API3
title: Api3
pageHeader: Members
outline: deep
---
Expand Down Expand Up @@ -29,13 +29,13 @@ To view the percentage of staked tokens in the pool for an address, visit the

In order for your proposal to succeed, a few steps are highly recommended.

1. Promote your idea and gather feedback on the API3 forum using a
1. Promote your idea and gather feedback on the Api3 forum using a
[sentiment check post](https://forum.api3.org/t/sentiment-check-template/56).
Generally, ideas receiving community engagement on the forum are more likely
to pass once crafted as official proposals.
2. Create an
[official proposal](https://forum.api3.org/t/api3-dao-example-proposal-template/52)
post on the API3 forum. This should contain a link to the proposal
post on the Api3 forum. This should contain a link to the proposal
description on IPFS.
3. After receiving feedback from the above steps, create a formal proposal using
the DAO dashboard as described below.
Expand Down Expand Up @@ -68,7 +68,7 @@ relative majority support.
your proposal for discussion.

**Why use IPFS?** Consider this use case: You posted on the
[API3 forum](https://forum.api3.org/) about a potential proposal. You
[Api3 forum](https://forum.api3.org/) about a potential proposal. You
received positive feedback and decided to formally create a proposal using
the DAO dashboard. In the proposal's description field you provide a link
back to the forum so people can again see the proposal details. How does the
Expand Down Expand Up @@ -157,7 +157,7 @@ transfer(address,uint256)
9. Click **Create** \
The proposal is then added to the proposal list and can be voted on.
10. **Return to the
[API3 forum](https://forum.api3.org/c/official-proposals/5)** \
[Api3 forum](https://forum.api3.org/c/official-proposals/5)** \
Add a comment to your post with a link to your newly created proposal. This
will help encourage community members to vote.

Expand Down
2 changes: 1 addition & 1 deletion docs/members/staking.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: API3
title: Api3
pageHeader: Members
outline: deep
---
Expand Down
2 changes: 1 addition & 1 deletion docs/members/voting.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: API3
title: Api3
pageHeader: Members
outline: deep
---
Expand Down
6 changes: 3 additions & 3 deletions docs/overview/contributors.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: API3
title: Api3
pageHeader: Overview
outline: deep
---
Expand All @@ -10,10 +10,10 @@ outline: deep

Contributors receive grants from the DAO and are often composed of hierarchical
teams which manage, streamline, and secure the success of their deliverables to
API3.
Api3.

A best-practice workflow is to form off-chain teams and apply for grants to
execute one-time projects or time-defined operations that will benefit API3. The
execute one-time projects or time-defined operations that will benefit Api3. The
team makes the grant application with a multisig that has the team members
assigned as owners, and the DAO permissionless-ly transfers the grant to the
multisig if the proposal is accepted and passed by the DAO contract logic.
Expand Down
6 changes: 3 additions & 3 deletions docs/overview/dao-tracker.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: API3
title: Api3
pageHeader: Overview
outline: deep
---
Expand All @@ -11,8 +11,8 @@ outline: deep
The [DAO Tracker](https://tracker.api3.org/) is a community-developed tool that
provides additional insight into the DAO beyond what is offered by the
intentionally minimalist DAO Dashboard. The DAO Tracker covers staking and
rewards, member wallets, proposals, and the API3 DAO treasury.
rewards, member wallets, proposals, and the Api3 DAO treasury.

Its [open source codebase](https://github.com/api3dao/api3-tracker) was
initially developed by GitHub user EnormousCloud and is now maintained by the
API3 team.
Api3 team.
6 changes: 3 additions & 3 deletions docs/overview/governance.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: API3
title: Api3
pageHeader: Overview
outline: deep
---
Expand All @@ -11,9 +11,9 @@ outline: deep
The DAO votes on high-level matters such as staking incentives and
collateralization (parameters of the DAO smart contract itself), as well as
grant proposals that directly transfer DAO treasury assets to contributors of
API3.
Api3.

The API3 ecosystem is a single token environment, using its native token (API3).
The Api3 ecosystem is a single token environment, using its native token (API3).
Check out the Medium post
[API3 Tokenomics Update](https://medium.com/api3/api3-tokenomics-update-f032d6e49b30)
for an in-depth overview on API3 tokenomics. To participate in governance, you
Expand Down
2 changes: 1 addition & 1 deletion docs/overview/rewards.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: API3
title: Api3
pageHeader: Overview
outline: deep
---
Expand Down
Binary file removed docs/public/img/API3-Active.png
Binary file not shown.
Binary file added docs/public/img/android-chrome-192x192.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/public/img/api3-inactive.png
Binary file not shown.
3 changes: 3 additions & 0 deletions docs/public/img/api3-logo-dark-theme.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/public/img/api3-logo-light-theme.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading