chore: docs cleanup

ar-io · Dec 9, 2024 · f215272 · f215272
1 parent 700258d
commit f215272
Show file tree

Hide file tree

Showing 10 changed files with 69 additions and 68 deletions.
diff --git a/docs/src/.vuepress/theme/configs/default_sidebar_config.js b/docs/src/.vuepress/theme/configs/default_sidebar_config.js
@@ -5,7 +5,7 @@ module.exports = [
   },
   {
     title: "White Paper",
-    path: "https://arweave.net/lNjWn3LpyhKC95Kqe-x8X2qgju0j98MhucdDKK85vc4",
+    path: "https://whitepaper_ar-io.arweave.net",
   },
   {
     title: "Network Overview",
@@ -19,7 +19,7 @@ module.exports = [
         path: "/arweave",
       },
       {
-        title: "The IO Token",
+        title: "The ARIO Token",
         path: "/token.md",
       },
       {
@@ -96,10 +96,10 @@ module.exports = [
         title: "AR.IO Admin API",
         path: "/gateways/ar-io-node/admin/admin-api",
       },
-      {
-        title: "Upgrading to Observer",
-        path: "/gateways/ar-io-node/observer-upgrade",
-      },
+      // {
+      //   title: "Upgrading to Observer",
+      //   path: "/gateways/ar-io-node/observer-upgrade",
+      // },
       {
         title: "Certbot Setup",
         children: [
@@ -178,32 +178,32 @@ module.exports = [
   {
     title: "Guides",
     children: [
-      {
-        title: "Arweave Name System (ArNS)",
-        children: [
-          {
-            title: "ArNS App",
-            children: [
-              {
-                title: "Overview",
-                path: "/guides/arns/overview",
-              },
-              {
-                title: "Registering a Name",
-                path: "/guides/arns/registering",
-              },
-              {
-                title: "Managing Assets",
-                path: "/guides/arns/managing",
-              },
-            ],
-          },
-          {
-            title: "ANTs on Bazar",
-            path: "/guides/ants-on-bazar"
-          },
-        ],
-      },
+      // {
+      //   title: "Arweave Name System (ArNS)",
+      //   children: [
+      //     {
+      //       title: "ArNS App",
+      //       children: [
+      //         {
+      //           title: "Overview",
+      //           path: "/guides/arns/overview",
+      //         },
+      //         {
+      //           title: "Registering a Name",
+      //           path: "/guides/arns/registering",
+      //         },
+      //         {
+      //           title: "Managing Assets",
+      //           path: "/guides/arns/managing",
+      //         },
+      //       ],
+      //     },
+      //     {
+      //       title: "ANTs on Bazar",
+      //       path: "/guides/ants-on-bazar"
+      //     },
+      //   ],
+      // },
       {
         title: "GraphQL",
         path: "/guides/gql",
@@ -212,23 +212,23 @@ module.exports = [
         title: "Deploy a Website or Application",
         path: "/guides/github-flow"
       },
-      {
-        title: "Experimental",
-        children: [
-          {
-            title: "AO ArNS Resolver",
-            path: "/experimental/ao-resolver",
-          },
-          {
-            title: "AO ANT",
-            path: "/experimental/ao-ant",
-          },
-          {
-            title: "Farcaster Frames",
-            path: "/gateways/ar-io-node/experimental/frames",
-          },
-        ],
-      },
+      // {
+      //   title: "Experimental",
+      //   children: [
+      //     {
+      //       title: "AO ArNS Resolver",
+      //       path: "/experimental/ao-resolver",
+      //     },
+      //     {
+      //       title: "AO ANT",
+      //       path: "/experimental/ao-ant",
+      //     },
+      //     {
+      //       title: "Farcaster Frames",
+      //       path: "/gateways/ar-io-node/experimental/frames",
+      //     },
+      //   ],
+      // },
       {
         title: "Projects",
         children: [

diff --git a/docs/src/community-resources.md b/docs/src/community-resources.md
@@ -11,4 +11,4 @@ next: false
 
 [ar.io Discord](https://discord.gg/7zUPfN4D6g)
 
-[Contact Us Directly](mailto:[email protected])
+<!-- [Contact Us Directly](mailto:[email protected]) -->
diff --git a/docs/src/gateway-network.md b/docs/src/gateway-network.md
@@ -83,6 +83,7 @@ In the AR.IO Network, "staking" designates the act of locking a specified amount
 
 It is important to note that unlike other protocols, the ARIO token is non-inflationary. Therefore, the staking mechanism in the AR.IO Network is not designed to function as a yield-generation tool. By staking their tokens, participants become eligible for potential rewards, fostering an atmosphere of mutual trust within the network. Specifically, Gateway operators stake tokens to facilitate their Gateway integration and establish public trust. Once connected, they become eligible for rewards driven by the protocol and gain access to the network's shared resources.
 
+<!-- 
 ## Schema
 
 ### Gateway Schema
@@ -249,4 +250,4 @@ It is important to note that unlike other protocols, the ARIO token is non-infla
         </tr>
     </table>
 </div>
-
+ -->
diff --git a/docs/src/gateways/ar-io-node/arnsoip/observer.md b/docs/src/gateways/ar-io-node/arnsoip/observer.md
@@ -23,7 +23,7 @@ The Observation protocol is organized around epochs, periods of time that are br
 <div class="caption">Observation and Incentive Protocol</div>
 
 - To participate in the epoch, a gateway must have already staked ARIO tokens and joined the network before it starts. 
-- Each epoch (approximately 7 block-days), a random pool of active gateways will be selected (prescribed) to perform observation duties.  
+- Each epoch (approximately 7 days), a random pool of active gateways will be selected (prescribed) to perform observation duties.  
 - Within the epoch, observers are tasked with evaluating a subset of ArNS names for each gateway in the network.  
 - By the end of the epoch’s observation reporting period, the observer must upload its standardized health observation report to Arweave. 
 - The observer must also submit an interaction to the AR.IO contract to save its report transaction ID and a summary of all failed gateways for tallying by the incentive protocol. 
@@ -39,11 +39,11 @@ The to-be-evaluated ArNS names include a set of names randomly determined by the
 
 Each observer shall assess the performance of the selected ArNS names (across all gateways) and summarize those findings in a report which details the following: 
 
-- General Information: Observer's Arweave address, starting and concluding block heights for the epoch. 
+- General Information: Observer's Arweave address, starting and concluding timestamps for the epoch. 
 
 - Gateway Operator Assessment: The expected and actual Arweave addresses of observed gateways, along with a summary verdict (pass or fail), and accompanying reasons for failure. 
 
-- Detailed ArNS Evaluations: For each gateway, it includes the domain name, evaluated ArNS names, the associated block height, transaction IDs, data hashes, a "pass or fail" score, reasons for failure (if any), and performance metrics like time to the first byte. 
+- Detailed ArNS Evaluations: For each gateway, it includes the domain name, evaluated ArNS names, the associated timestamp, transaction IDs, data hashes, a "pass or fail" score, reasons for failure (if any), and performance metrics like time to the first byte. 
 
 A comprehensive list of report criteria can be found in the Appendix. 
 
@@ -61,7 +61,7 @@ The weighted selection criteria will consider the following for each gateway:
 
 - Stake Weight (SW): This factor considers how financially committed a gateway is to the network. It is the ratio of the amount of ARIO tokens staked by the gateway relative to the network minimum and is expressed as SW = Gateway Stake / Minimum Stake. 
 
-- Tenure Weight (TW): This factor considers how long a gateway has been part of the network, with a maximum value capped at 4. It is calculated as TW = Gateway Network Tenure / 6 block-months. This means that the maximum value is achieved after 2 block-years of participation in the network. 
+- Tenure Weight (TW): This factor considers how long a gateway has been part of the network, with a maximum value capped at 4. It is calculated as TW = Gateway Network Tenure / 6 months. This means that the maximum value is achieved after 2 years of participation in the network. 
 
 - Gateway Reward Ratio Weight (GRRW): This factor is a proxy for a gateway’s performance at resolving ArNS names. The weight represents the ratio of epochs in which a gateway received rewards for correctly resolving names relative to their total time on the network. 
 
@@ -140,8 +140,8 @@ Each observer shall assess the performance of the selected ArNS names (across al
 ## General Information
 
 - The observer's Arweave address.
-- The starting block height of the epoch.
-- The block height at which the report was generated.
+- The starting timestamp of the epoch.
+- The timestamp at which the report was generated.
 
 ## Overall Gateway Operator Assessment
 
@@ -154,7 +154,7 @@ Each observer shall assess the performance of the selected ArNS names (across al
 ## ArNS Assessments
 
 - Observed ArNS name (for all prescribed and chosen names). 
-- The block height at which the name was assessed. 
+- The timestamp at which the name was assessed. 
 - The expected status code. 
 - The resolved status code.  
 - The transaction ID that the observer expects the associated name to resolve to. 

diff --git a/docs/src/gateways/ar-io-node/testnet.md b/docs/src/gateways/ar-io-node/testnet.md
@@ -15,13 +15,13 @@ tags: [testnet, join, application, jwk, qty, fqdn, label, note, properties]
 2. Gateway must be associated with an Arweave Wallet.
     - Learn about creating Arweave wallets [here](https://ar.io/wallet)
 
-3. Arweave wallet must be funded with enough AR tokens to pay for transaction gas.
+3. Arweave wallet must be funded with enough [ARIO tokens](https://ar.io/test-ario) to meet the minimum stake for gateway operators.
 
-## Submit an Application
+<!-- ## Submit an Application
 
 Joining the ar.io Testnet requires staking a minimum of 10,000 Test ARIO Tokens. You must have Test ARIO Tokens before you are able to join. Test ARIO Tokens are currently not being distributed.
 
-New applications for joining the Testnet are not currently being accepted. Be sure to join the [ar.io Discord](https://discord.com/invite/7zUPfN4D6g) to stay up to date on Testnet status and possible future availability prior to the launch of the Mainnet. -->
+New applications for joining the Testnet are not currently being accepted. Be sure to join the [ar.io Discord](https://discord.com/invite/7zUPfN4D6g) to stay up to date on Testnet status and possible future availability prior to the launch of the Mainnet. --> -->
 
 <!-- ## Setting up and Running the Join Script
 

diff --git a/docs/src/glossary.md b/docs/src/glossary.md
@@ -53,7 +53,7 @@ A nonbinary, many axis scale enabling a system or platform to be: permissionless
 
 ## **Epoch**: 
 
-A specific duration (e.g., one block-week) during which network activities and evaluations are conducted. It serves as a key time frame for processes such as observation duties, performance assessments, and reward distributions within the network's protocols. 
+A specific duration (e.g., one week) during which network activities and evaluations are conducted. It serves as a key time frame for processes such as observation duties, performance assessments, and reward distributions within the network's protocols. 
 
 ## **Gateway**: 
 
@@ -109,7 +109,7 @@ The [normalized address](#normalized-address) of the [owner](#owner)
 
 ## **Period**: 
 
-Refers to a predefined time span (e.g., a block-day) that serves as a cycle for network activities such as dynamic pricing. It is a fundamental unit of time for operational and protocol processes within the network. 
+Refers to a predefined time span (e.g., a day) that serves as a cycle for network activities such as dynamic pricing. It is a fundamental unit of time for operational and protocol processes within the network. 
 
 ## **Permaweb**: 
 
@@ -145,4 +145,4 @@ Relates to enacting network security by minimizing the number of entities and th
 
 ## **Vault**: 
 
-Token vaults are protocol level mechanisms used to contain staked tokens over time. Each vault contains a starting block height, ending block height (if applicable), along with a balance of tokens. 
+Token vaults are protocol level mechanisms used to contain staked tokens over time. Each vault contains a starting timestamp, ending timestamp (if applicable), along with a balance of tokens. 
diff --git a/docs/src/guides/sdk.md b/docs/src/guides/sdk.md
@@ -143,7 +143,7 @@ The SDK provides TypeScript types. When you import the SDK in a TypeScript proje
 
 **NOTE**: Typescript version 5.3 or higher is recommended.
 
-## ARIOToken & mARIOToken
+## ARIO Token & mARIO Token
 
 The ArIO contract stores all values as mARIO (milli-ARIO) to avoid floating-point arithmetic issues. The SDK provides an `IOToken` and `mIOToken` classes to handle the conversion between ARIO and mARIO, along with rounding logic for precision.
 

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -33,7 +33,7 @@ Data in paradise. The AR.IO ecosystem is dedicated to cultivating products and p
 </div>
 
 <div class="home-box">
-<a href="https://arweave.net/lNjWn3LpyhKC95Kqe-x8X2qgju0j98MhucdDKK85vc4" target="_blank">
+<a href="https://whitepaper_ar-io.arweave.net" target="_blank">
 <img class="smaller-image" :src="$withBase('/images/4-White-Paper.png')">
 <h3>White Paper</h3>
 <p>A comprehensive document that details a decentralized and incentivized gateway network aimed at making the permaweb more accessible to all.</p>

diff --git a/docs/src/introduction.md b/docs/src/introduction.md
@@ -15,7 +15,7 @@ AR.IO is a global network, protocol, and currency that enables the permaweb. It
 
 The various nodes on the AR.IO Network, known as gateways, are the interface between users and the permaweb. Each gateway acts like a “Permaweb Service Provider” and supports multiple, value-added, services like reading, writing, querying, and indexing of Arweave data.
 
-The AR.IO token, referred to as IO or ɸ, is an aoComputer based token used for protocol incentives, gateway accountability, and payments for services like the Arweave Name System (ArNS). It will enable gateways on the AR.IO Network to operate under a low-trust model with the users of their service.
+The AR.IO token is an aoComputer based token used for protocol incentives, gateway accountability, and payments for services like the Arweave Name System (ArNS). It will enable gateways on the AR.IO Network to operate under a low-trust model with the users of their service.
 
 ## Why AR.IO ?
 

diff --git a/docs/src/token.md b/docs/src/token.md
@@ -8,7 +8,7 @@ permalink: "/token/"
 
 ## Overview
 
-ARIO is the multifunction aoComputer based token that powers The AR.IO Network and its suite of permaweb applications. The ARIO Token (ɸ) has many uses, including:
+ARIO is the multifunction aoComputer based token that powers The AR.IO Network and its suite of permaweb applications. The ARIO Token has many uses, including:
 
 - Protocol incentives,
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,4 +11,4 @@ next: false

		[ar.io Discord](https://discord.gg/7zUPfN4D6g)

		[Contact Us Directly](mailto:[email protected])
		<!-- [Contact Us Directly](mailto:[email protected]) -->