availproject · Genesis3800 · May 24, 2024 · May 16, 2024 · May 16, 2024 · May 16, 2024
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,48 +2,8 @@
 
 The Documentation team at Avail are the primary maintainers of the Avail Documentation and will review all issues and pull requests created in this repository.
 
-<!-- TOC -->
-
-- [Contribution Guidelines](#contribution-guidelines)
-  - [Ways to Contribute to the Avail Documentation](#ways-to-contribute-to-the-avail-documentation)
-  - [How to Contribute Changes via the Avail Documentation Website](#how-to-contribute-changes-via-the-avail-documentation-website)
-  - [How to Locally Run the Avail Documentation](#how-to-locally-run-the-avail-documentation)
-    - [Quick Run](#quick-run)
-    - [Setup Steps](#setup-steps)
-  - [License](#license)
-  <!--/ TOC -->
-
-## Ways to Contribute to the Avail Documentation
-
-If you spot typos or grammar mistakes, please go ahead and submit a pull request with the fixes. For more significant changes, it's advisable to start with a GitHub issue to discuss it with the maintainers. We generally prefer pull requests over issues for suggesting changes to the Docs.
-
-| ❗ We are in the process of setting guidelines to ensure all new contributions continue to improve the Docs without compromising its quality. Please stay tuned. |
-| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-
-Before making a contribution, please consult any existing issues or initiate a new discussion to ensure alignment with the documentation's objectives.
-Your contributions can significantly enrich the Docs in the following ways:
-
-1. **General Overviews**: Introductory articles that provide a comprehensive understanding of Avail's data availability layer and modular approach to blockchains.
-
-2. **Technical Deep Dives**: Detailed explorations into specific components of Avail's architecture, such as its data availability layer, modularity, and consensus algorithms.
-
-3. **Use-Case Scenarios**: Articles that showcase real-world applications of Avail in solutions like validiums, appchains, and sovereign rollups.
-
-4. **Tooling**: Documentation or guides on tools that facilitate development, testing, or deployment on Avail. This could include IDE plugins, testing frameworks, or monitoring tools.
-
-5. **Third-Party Services and Deployments**: Information on external services, deployments, and implementations that integrate with Avail. This could include oracles, data analytics platforms, liquidity providers, as well as infrastructure solutions that provide Avail-based infrastructure.
-
-6. **Community Contributions**: Lists of active Avail communities, educational resources, or upcoming events that enrich the ecosystem.
-
-7. **Governance & Economics**: Insights into the governance model and tokenomics that underpin Avail's network.
-
-8. **Security Practices**: Guidelines and resources for ensuring the security and integrity of applications, smart contracts, and general infrastructure on Avail.
-
-9. **Troubleshooting Guides**: Solutions to common challenges, FAQs, and other resources that assist both newcomers and experienced users.
-
-10. **Emerging Technologies**: Articles on upcoming features, advancements, or experimental technologies in the Avail pipeline. For instance, contributions could explore the impact of "Dank Sharding" on Avail's scalability, transaction costs, and its enablement of new decentralized applications.
-
-> Note: This is a general overview and the actual repository may contain additional files and folders for specific functionalities.
+> ℹ️ Please make sure to create an issue outlining your feedback/content request for the docs before creating a PR.
+> PRs created without approval will be closed. We are open to technical articles on a wide variety of topics related to Avail and Web3 in general. If you have something in mind, please feel free to jump in with an issue on the repo.
 
 ## How to Contribute Changes via the Avail Documentation Website
 
@@ -56,61 +16,56 @@ Contributing to the Avail Documentation is simple. You'll need a GitHub account
 5. **Initiate Pull Request**: Scroll to the bottom and click on **Create pull request**.
 6. **Title Your PR**: Give your pull request a descriptive title. For example, if you're editing the "Getting Started" page, you could title it _Update /docs/getting-started.md_.
 7. **Describe Changes**: In the pull request description, specify the issue your changes resolve.
+
    > See [GitHub Docs on Linking a Pull Request to an Issue](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) for guidance.
+
 8. **Additional Information**: Provide a concise summary of the changes you've made. Include screenshots or references if applicable.
 9. **Submit**: Click **Propose changes** to finalize your pull request. This will create a new branch in your fork.
 
 ## How to Locally Run the Avail Documentation
 
-### Quick Run
-
-For those who want to quickly install and start the Avail Documentation locally, you can follow these steps:
-
-```bash
-yarn
-yarn start
-```
-
-### Setup Steps
-
 > **Prerequisites**:
 >
 > - [Node.js](https://nodejs.org/en/download/) (version >= 16.14.1)
 > - [pnpm](https://pnpm.io/installation) 
 >   **Note for macOS Users**: Xcode and Command Line Tools are required.
 
-1. **Fork the Repository**
+1. **Fork the repository**
 
    > See [GitHub Docs: Fork a repo](https://help.github.com/en/articles/fork-a-repo) for guidance.
 
-2. **Clone Your Fork**
+2. **Clone your fork**
 
    ```bash
-   git clone [email protected]:availproject/availproject.github.io.git
+   git clone https://github.com/Genesis3800/docs.git
    ```
 
+   This will create a repo named `docs` in your current directory.
+
 3. **Navigate to the Repository**
 
    ```bash
-   cd availproject.github.io
+   cd docs
    ```
 
 4. **Add Upstream Remote**
 
    > Refer to [GitHub Docs: Configuring a remote for a fork](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork).
 
    ```bash
-   git remote add upstream https://github.com/availproject/availproject.github.io
+   git remote add upstream https://github.com/availproject/docs
    ```
 
+   > ℹ️ You can check if the upstream was added correctly by running `git remote -v`
+
 5. **Sync Your Fork**
 
    > See [GitHub Docs: Syncing a fork](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork).
 
    ```bash
-   git checkout master
+   git checkout main
    git fetch upstream
-   git merge upstream/master
+   git merge upstream/main
    ```
 
 6. **Install Dependencies**
@@ -127,8 +82,32 @@ yarn start
    pnpm run dev
    ```
 
-  This will start a local dev derver at `http://localhost:3000` on your machine. 
+  This will start a local dev derver at `http://localhost:3000` on your machine.
+
+## Push changes and create PR
+
+Once you are done with all the changes, save all you files and run:
+
+1. ```bash
+   git add .
+   ```
+
+   to stage all the changes.
+
+2. ```bash
+   git commit -m "Your commit message"
+   ```
+
+   to commit the changes with ann appropriate commit message.
+
+3. Once you have committed all the changes, push the changes to your forked repository by running:
+
+   ```bash
+   git push origin main
+   ```
+
+   Now you can use the Github UI to create a PR from your forked repository to the `staging` branch of the upstream repository.
 
 ## License
 
-The Avail Project Developer Documentation is licensed under the [MIT License](./LICENSE) free software license.### How to Contribute Changes via the Avail Documentation Website
+The Avail Project Developer Documentation is licensed under the [MIT License](./LICENSE) free software license.### How to Contribute Changes via the Avail Documentation Website.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Avail Project Documentation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/pages/docs/end-user-guide/accounts.mdx b/pages/docs/end-user-guide/accounts.mdx
@@ -32,13 +32,13 @@ NEVER EVER share your seed phrase with anyone and keep it in a secure location.
 
 ## Creating an Account on Avail DA
 
-In this guide, we will walk you through two different ways of creating an account on the Goldberg testnet of Avail DA.
+In this guide, we will walk you through two different ways of creating an account on Avail DA.
 
-1. **Using a compatible wallet**: You can create an account on the Goldberg testnet by using wallets like
+1. **Using a compatible wallet**: You can create an account by using wallets like
 [SubWallet](https://www.subwallet.app/), [Talisman](https://www.talisman.xyz/), [PolkadotJS](https://polkadot.js.org/) and others.
 This guide will be using Subwallet as an example.
 
-2. **Using the Goldberg Testnet Explorer**: Advanced users can also create an account on the Goldberg testnet straight from the explorer.
+2. **Using the Explorer**: Advanced users can also create an account straight from the explorer.
 
 <Tabs items={['Using Subwallet', 'Using PolkadotJS or Talisman' , 'Using Klever Wallet', 'Using the explorer' ]}>
 
@@ -71,12 +71,12 @@ Make sure to store it in a safe place as it is the only way to recover your acco
 <br/>
 <img src="/img/subwallet/subwallet_5.jpeg" width="100%" height="100%" />
 
-6. Search for the Goldberg testnet either by name or by token symbol. Make sure the network is toggled on.
+6. Search for Avail testnets either by name or by token symbol. Make sure the network is toggled on.
 <br/>
 <img src="/img/subwallet/subwallet_6.jpeg" width="100%" height="100%" />
 
 7. Next go to your extension's homepage and click on the `Get address` button.
-Again, search for the Goldberg testnet by name or token symbol, and click on the `copy address` button.
+Again, search for Avail testnets by name or token symbol, and click on the `copy address` button.
 <br/>
 <img src="/img/subwallet/subwallet_7.jpeg" width="100%" height="100%" />
 <br/>
@@ -184,4 +184,4 @@ Always keep your JSON file in a secure and offline location. Losing this file an
 
 Congratulations on successfully creating and managing your Avail account! Remember to always safeguard your account details, JSON file, and seed phrase to ensure the security of your assets.
 
-Ready to explore further? Navigate to the next guide to learn [<ins>how to use the Goldberg Testnet Explorer</ins>](/docs/end-user-guide/explorer) and get hands-on experience with the network.
+Ready to explore further? Navigate to the next guide to learn [<ins>how to use the Avail Explorer</ins>](/docs/end-user-guide/explorer) and get hands-on experience with the network.
diff --git a/pages/docs/end-user-guide/balance-transfers.mdx b/pages/docs/end-user-guide/balance-transfers.mdx
@@ -2,7 +2,7 @@
 id: balance-transfers
 title: How to Perform Balance Transfers on Avail
 sidebar_label: Balance Transfers
-description: 'Learn how to perform balance transfers on the Goldberg testnet.'
+description: 'Learn how to perform balance transfers on the Avail Network.'
 keywords:
   - docs
   - avail
@@ -22,21 +22,6 @@ import { Callout } from 'nextra/components'
 
 Balance transfers are a method for transferring funds from one account to another. This guide will walk you through the process using [<ins>Avail-JS UI</ins>](https://explorer.avail.so/). Before you begin, ensure you have [<ins>created an account</ins>](/docs/end-user-guide/accounts) and have [<ins>funds available</ins>](/docs/end-user-guide/faucet) for transfer.
 
-<Callout type="info">
-CLASH OF NODES<br/>
-In the balance transfer challenge part of Clash of Nodes, participants must follow these guidelines:
-
-1. **Token Acquisition**: To participate in balance transfers, tokens must be acquired through the designated [<ins>faucet</ins>](/docs/end-user-guide/faucet).
-2. **Faucet Transfer Limit**: Participants can obtain tokens from the [<ins>faucet</ins>](/docs/end-user-guide/faucet) only once per day.
-3. **Regular Engagement**: Participants are encouraged to engage with the challenge daily. The daily acquisition of tokens from the faucet and subsequent transfers cultivate consistent participation.
-</Callout>
-
-<Callout>
-USING SUBWALLET<br/>
-[<ins>SubWallet</ins>](https://www.subwallet.app/) currently supports the Goldberg testnet and can be used for balance transfers.
-
-Please view the third-party content disclaimer [<ins>here</ins>](https://github.com/availproject/availproject.github.io/blob/main/CONTENT_DISCLAIMER.md).
-</Callout>
 
 ## Transferring Funds Using Avail-JS
 
@@ -48,7 +33,7 @@ Please view the third-party content disclaimer [<ins>here</ins>](https://github.
 
 <Callout type="info">
 MINIMUM BALANCE<br/>
-On Avail, similar to other Substrate-based chains, an account must hold a minimum balance to stay active. This minimum, known as the Existential Deposit (ED), is set at **0.00001 AVAIL on the Goldberg testnet**. The ED helps prevent blockchain bloat from accounts with tiny or zero balances, thereby maintaining network efficiency and low fees. If an account's balance falls below this threshold, it gets deactivated, and the remaining balance is removed. Reactivating the account requires a deposit larger than the ED, but this won't restore the lost funds.
+On Avail, similar to other Substrate-based chains, an account must hold a minimum balance to stay active. This minimum, known as the Existential Deposit (ED), is set at **0.000001 AVAIL on the Avail Network**. The ED helps prevent blockchain bloat from accounts with tiny or zero balances, thereby maintaining network efficiency and low fees. If an account's balance falls below this threshold, it gets deactivated, and the remaining balance is removed. Reactivating the account requires a deposit larger than the ED, but this won't restore the lost funds.
 </Callout>
 
 4. When you are ready to execute your transaction, enter your password and click on the "Sign and Submit" button.
diff --git a/pages/docs/end-user-guide/explorer.mdx b/pages/docs/end-user-guide/explorer.mdx
@@ -1,6 +1,6 @@
 ---
 id: explorer
-title: How to Use the Goldberg Testnet Explorer
+title: How to Use the Avail Explorer
 sidebar_label: Use the Explorer
 description: A comprehensive guide on using the Avail Explorer to interact with the Avail network.
 keywords:
@@ -12,11 +12,11 @@ image: https://docs.availproject.org/img/avail/AvailDocs.png
 ---
 import { Callout } from 'nextra/components'
 
-# How to Use the Goldberg Testnet Explorer
+# How to Use the Avail Explorer
 
 ## Introduction
 
-The [<ins>Goldberg Testnet Explorer</ins>](https://explorer.avail.so/) serves as a powerful interface for interacting with the Avail network. Whether you're a developer, a validator, or an end-user, the explorer provides you with the tools to inspect network activities, manage accounts, and participate in governance. This guide will walk you through its key features.
+The [<ins>Avail Explorer</ins>](https://explorer.avail.so/) serves as a powerful interface for interacting with the Avail network. Whether you're a developer, a validator, or an end-user, the explorer provides you with the tools to inspect network activities, manage accounts, and participate in governance. This guide will walk you through its key features.
 
 ### Quick Navigation
 

diff --git a/pages/docs/end-user-guide/identity.mdx b/pages/docs/end-user-guide/identity.mdx
@@ -2,7 +2,7 @@
 id: identity
 title: How to Set an On-Chain Identity
 sidebar_label: Set Your Identity
-description: 'Learn how to set an on-chain identity on the Goldberg testnet.'
+description: 'Learn how to set an on-chain identity on the Avail Network.'
 keywords:
   - docs
   - avail
@@ -15,13 +15,13 @@ image: https://docs.availproject.org/img/avail/AvailDocs.png
 
 ## Introduction
 
-This guide will walk you through the process of setting an on-chain identity on the Goldberg testnet.
+This guide will walk you through the process of setting an on-chain identity on the Avail network.
 
 ## Reserve Funds for Identity Bonding
 
 To store personal information on-chain, users are required to lock a specific amount of funds as a bond. This bond is refundable upon the clearance of the identity.
 
-Retrieve the necessary bond amounts by querying the [<ins>Chain state constants</ins>](https://explorer.avail.so/#/chainstate) on the [<ins>Goldberg Explorer</ins>](/docs/end-user-guide/explorer).
+Retrieve the necessary bond amounts by querying the [<ins>Chain state constants</ins>](https://explorer.avail.so/#/chainstate) on the [<ins>Avail Explorer</ins>](/docs/end-user-guide/explorer).
 
 ### Accessing Chain State Constants