Skip to content

Commit

Permalink
Replace site url (#150)
Browse files Browse the repository at this point in the history
* Replace OAK Foundation to Ava Protocol

* Replace OAK Network to Ava Protocol

* Replace github url

* Replace OAK with Ava Protocol

* Change oak.tech to avaprotocol.org

* Change docs.oak.tech to avaprotocol.org

* Replace OAK's to Ava Protocol's

* Change @oak.tech to @avaprotocol.org

* Remove crowdloan page

* Change media links

* Replace OAK Network to Ava Protocol

* Change blog link

* Change twitter link

* Change token symbol

* Change paper name

* Change Oak to Ava Protocol

* Fix Ava Protocol

* Change favicon.png

* Change page title

* Change the page title

* Remove unused documents

* Remove unused author

* Change author to chris
  • Loading branch information
imstar15 authored and chrisli30 committed Jun 14, 2024
1 parent bb5dc59 commit a82fe27
Show file tree
Hide file tree
Showing 57 changed files with 200 additions and 613 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OAK-docs
# Ava Protocol Documentation

This site was developed by [OAK Foundation](https://oak.tech).
This site was developed by [Ava Protocol](https://avaprotocol.org).
## Installation

Install the dependencies with [Bundler](http://bundler.io/):
Expand Down
33 changes: 6 additions & 27 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.

# Site title and description
title: OAK Docs
description: Documentation for OAK Blockchain
title: Ava Protocol
description: Documentation for Ava Protocol
lang: en

# Site subpath, e.g. /blog
Expand Down Expand Up @@ -41,35 +41,14 @@ authors:
name: Charles Chen
title: Developer
avatar: avatar-xingyou.png
irsal:
name: Irsal McGinnis
title: CTO
avatar: avatar-irsal.jpeg
ryan:
name: Ryan Huttman
title: Lead Engineer
avatar: avatar-ryan.png
andrew:
name: Andrew Tomaka
title: Software Engineer
laura:
name: Laura Reesby
title: Software Engineer
avatar: avatar-laura.jpeg
christian:
name: Christian Dirk
title: Growth Team
nikhil:
name: Nikhil Vengal
title: Software Engineer
vinh:
name: Vinh Nguyen
title: Software Engineer

# Social icons displayed in footer
social:
email: chris@oak.tech
website: https://oak.tech
email: chris@avaprotocol.org
website: https://avaprotocol.org
facebook:
flickr:
dribbble:
Expand All @@ -78,7 +57,7 @@ social:
instagram:
linkedin:
pinterest:
twitter: https://twitter.com/oak_network
twitter: https://x.com/ava_protocol
vimeo:
youtube: https://www.youtube.com/channel/UCpR12msmm43z46PoAJ1TAiQ

Expand All @@ -91,7 +70,7 @@ share:

# Default footer image settings
footer:
copyright: © 2022 OAK Foundation. All rights reserved.
copyright: © 2024 Ava Protocol. All rights reserved.

# Disqus comments shortname, requires Disqus account https://disqus.com/
# disqus:
Expand Down
6 changes: 3 additions & 3 deletions _data/navigation_boxes.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Boxes include navigation

- title: How OAK Blockchain Works
desc: Get familiar with the key concepts behind OAK, learn about the core stack, and what it can do for your project
- title: How Ava Protocol Works
desc: Get familiar with the key concepts behind Ava Protocol, learn about the core stack, and what it can do for your project
icon: bolt
doc: company-overview

Expand All @@ -11,7 +11,7 @@
doc: delegation-user

- title: API References
desc: Read our documentation for OAK APIs and SDKs
desc: Read our documentation for Ava Protocol APIs and SDKs
icon: code
doc: developer-guide-overview

Expand Down
2 changes: 1 addition & 1 deletion _data/navigation_footer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
url: /

- title: Blog
url: https://medium.com/oak-blockchain
url: https://avaprotocol.org/blog

- title: Contact
url: /contact/
4 changes: 2 additions & 2 deletions _data/navigation_header.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ left:
url: /docs/developer-guide-overview/

- title: Blog
url: https://medium.com/oak-blockchain
url: https://avaprotocol.org/blog


# Navbar right menu navigation links

right:

- title: Github
url: https://github.com/OAK-Foundation
url: https://github.com/AvaProtocol
button: primary-outline

- title: Contact
Expand Down
2 changes: 1 addition & 1 deletion _data/navigation_mobile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
url: /docs/developer-guide-overview/

- title: Blog
url: https://medium.com/oak-blockchain
url: https://avaprotocol.org/blog

- title: Contact
url: /docs/contact-us/
Expand Down
4 changes: 2 additions & 2 deletions _docs/benchmarking.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ For more information about how transaction fees are related to “weights”, pl

This article takes our Open Grant project, quadratic-funding-pallet as an example to explain the process of weight determination.

repo: <https://github.com/OAK-Foundation/quadratic-funding-pallet>
repo: <https://github.com/AvaProtocol/quadratic-funding-pallet>

1. __Complete pallet dev code__

Expand All @@ -42,7 +42,7 @@ repo: <https://github.com/OAK-Foundation/quadratic-funding-pallet>

The benchmarking.rs starts with a benchmarks! macro, and the majority of logic is in the function body. The last block, verifying final state is optional.

Take the [benchmarking.rs file of quadratic-funding](https://github.com/OAK-Foundation/quadratic-funding-pallet/blob/add_weights/pallets/quadratic-funding/src/benchmarking.rs) as an example:
Take the [benchmarking.rs file of quadratic-funding](https://github.com/AvaProtocol/quadratic-funding-pallet/blob/add_weights/pallets/quadratic-funding/src/benchmarking.rs) as an example:

![schedule_round](../../assets/img/benchmarking/schedule_round.png)

Expand Down
16 changes: 8 additions & 8 deletions _docs/bug-bounty.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ tags: [develop]
date: 2021-09-01
---

The OAK team is eager to engage developers in building the OAK Network ecosystem. In order to enhance the product’s user experience and to improve on-chain security, OAK team launched the first “Bug-Bounty” program with potential payouts of $2,500 per report.
The Ava Protocol team is eager to engage developers in building the Ava Protocol ecosystem. In order to enhance the product’s user experience and to improve on-chain security, Ava Protocol team launched the first “Bug-Bounty” program with potential payouts of $2,500 per report.
## Submission Guideline

1. The bug bounty program is only applicable to the OAK Network.
1. The bug bounty program is only applicable to the Ava Protocol.

2. Please read the following rules for your submission to be eligible:

For UI/UX bugs: please submit the exposed bugs in OAK’s Discord group.
For UI/UX bugs: please submit the exposed bugs in Ava Protocol’s Discord group.

For Security bugs: please submit a summary of the exposed bug to: <bugs@oak.tech>
For Security bugs: please submit a summary of the exposed bug to: <bugs@avaprotocol.org>

### Information to include in your report:

Expand Down Expand Up @@ -45,9 +45,9 @@ The OAK team is eager to engage developers in building the OAK Network ecosystem
4. Once your submission is accepted, we will contact you to collect your wallet information to issue the rewards.

## Scope
Currently, the following OAK Network code repositories are in scope for bug bounty program:
- [OAK's blockchain code](https://github.com/OAK-Foundation/OAK-blockchain)
- [Parachain Staking Module](https://github.com/OAK-Foundation/moonbeam/tree/oak-staging/pallets/parachain-staking)
Currently, the following Ava Protocol code repositories are in scope for bug bounty program:
- [Ava Protocol's blockchain code](https://github.com/AvaProtocol/OAK-blockchain)
- [Parachain Staking Module](https://github.com/AvaProtocol/moonbeam/tree/oak-staging/pallets/parachain-staking)

## Vulnerability Classifications
**High-risk Vulnerabilities:** stealing and arbitrarily issuing or distributing tokens/disrupting consensus causes the blockchain to stop generating blocks/destroying on-chain governance and software upgrade processes/memory leaks and abnormal resource consumption.
Expand All @@ -66,6 +66,6 @@ We have not set a maximum reward, and the specific amount of the bounty will var

All bounties will be paid in equivalent value of DOT.

The OAK Team will assess each vulnerability report and issue the bounty accordingly.
The Ava Protocol Team will assess each vulnerability report and issue the bounty accordingly.

For more questions, feel free to [Contact Us](../contact-us).
4 changes: 2 additions & 2 deletions _docs/collators.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Before you start producing blocks and earning rewards as a collator, you must fi
1. [Experienced Node Operators setup for Turing Network](../setup-collator-node)
2. [Using our partner services](../setup-collator-node-partner)

If you have any questions or run into issues, head over to the [OAK Discord](https://discord.gg/7W9UDvsbwh) for help.
If you have any questions or run into issues, head over to the [Ava Protocol Discord](https://discord.gg/7W9UDvsbwh) for help.

## Network Specific Information

Expand Down Expand Up @@ -176,7 +176,7 @@ Navigate to the extrinsics tab, and go to `parachainStaking.executeLeaveCandidat

## FAQ

For any questions or support, please reach out via [OAK Discord](https://discord.gg/7W9UDvsbwh), or email <collators@oak.tech>.
For any questions or support, please reach out via [Ava Protocol Discord](https://discord.gg/7W9UDvsbwh), or email <collators@avaprotocol.org>.

### When will my collator start producing blocks?

Expand Down
12 changes: 6 additions & 6 deletions _docs/company-overview.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: About OAK Network
title: About Ava Protocol
subtitle: Web3's hub for cross-chain automation.
author: chris
tags: [architecture]
date: 2022-02-05
---

[__OAK Network__](https://oak.tech) is Web3’s hub for cross-chain automation, enabling multi-chain apps to schedule and automate any substrate extrinsic or EVM smart contract function. OAK is built to deliver trustless automation, dedicating its block space and optimizing gas to store, trigger, and execute transactions to connected blockchains.
[__Ava Protocol__](https://avaprotocol.org) is Web3’s hub for cross-chain automation, enabling multi-chain apps to schedule and automate any substrate extrinsic or EVM smart contract function. Ava Protocol is built to deliver trustless automation, dedicating its block space and optimizing gas to store, trigger, and execute transactions to connected blockchains.

OAK’s automation combines off-chain data streams with event-driven execution to automatically execute any transaction or smart contract function. Cross-consensus messaging (XCM) enables OAK to not only automate transactions on OAK, but also on any connected blockchains without tokens or private keys ever touching OAK. OAK’s trustless automation unlocks rich user experiences including scheduled and recurring payments, stable-cost-averaging, stop loss orders, and automatically-compounding rewards for staking, liquidity pool participants, and money market deposits.
Ava Protocol’s automation combines off-chain data streams with event-driven execution to automatically execute any transaction or smart contract function. Cross-consensus messaging (XCM) enables Ava Protocol to not only automate transactions on Ava Protocol, but also on any connected blockchains without tokens or private keys ever touching Ava Protocol. Ava Protocol’s trustless automation unlocks rich user experiences including scheduled and recurring payments, stable-cost-averaging, stop loss orders, and automatically-compounding rewards for staking, liquidity pool participants, and money market deposits.

As a layer one blockchain, OAK provides automation infrastructure that enables decentralized applications to automate single or recurring transactions using a simple “if this” condition and “then that” transaction instruction.
As a layer one blockchain, Ava Protocol provides automation infrastructure that enables decentralized applications to automate single or recurring transactions using a simple “if this” condition and “then that” transaction instruction.

![oak_event_driven](../../assets/img/oak-event-driven.png)

Expand All @@ -31,7 +31,7 @@ For the everyday consumer to take decentralized automation for granted.
Assets are supported by the chain and no longer needs to tie up with one smart contract.

### One-to-many distribution
OAK VM supports the capability of sending to multiple addresses with one transaction.
Ava Protocol VM supports the capability of sending to multiple addresses with one transaction.

### Eliminate off-chain servers
Repetitive transactions can be triggered by on-chain event module.
Expand All @@ -43,7 +43,7 @@ Set up once, and the transaction can be triggered on-chain, care-free.
Different from EVM smart contracts, many core utility functions are secured by the network.

### Native upgradability
Based on Substrate, OAK Network will constantly evolve with forkless runtime upgrade.
Based on Substrate, Ava Protocol will constantly evolve with forkless runtime upgrade.

### Time-based guarantees for execution
Users can rest assured that their event will execute at a certain time with a specific margin.
42 changes: 0 additions & 42 deletions _docs/consensus.md

This file was deleted.

15 changes: 7 additions & 8 deletions _docs/contact-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,13 @@ date: 2021-05-11

Please contact us through below methods. Our decentralized team can usually respond within 8 hours.

1. Email: <[email protected]>
2. Twitter: [@oak_network](https://twitter.com/oak_network)
3. Telegram: [OAK Network Community](https://t.me/OAKNetworkCommunity)
4. Telegram: [OAK Network Announcements](https://t.me/OAK_Announcements)
5. Discord:[OAK Network](https://discord.gg/7W9UDvsbwh)
6. LinkedIn: <https://www.linkedin.com/company/oak-network>
7. Github: <https://github.com/OAK-Foundation/>
1. Email: <[email protected]>
2. Twitter: [@ava_protocol](https://x.com/ava_protocol)
3. Telegram: [Ava Protocol](https://t.me/ava_protocol)
4. Discord: [Ava Protocol](https://discord.gg/7W9UDvsbwh)
5. LinkedIn: <https://www.linkedin.com/company/avaprotocol>
6. Github: <https://github.com/AvaProtocol/>

For update suggestions of this documentation site, please create an issue in [github.com/OAK-Foundation/OAK-docs](https://github.com/OAK-Foundation/OAK-docs/issues).
For update suggestions of this documentation site, please create an issue in [github.com/AvaProtocol/OAK-docs](https://github.com/AvaProtocol/OAK-docs/issues).

Thank you!
Loading

0 comments on commit a82fe27

Please sign in to comment.